Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.
It takes time for Amazon Web Services 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 Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
", "idempotent":true }, "CreateQueue":{ "name":"CreateQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateQueueRequest"}, "output":{"shape":"CreateQueueResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"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.
", "idempotent":true }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterRequest"}, "output":{"shape":"DeleteClusterResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"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.
", "idempotent":true }, "DeleteComputeNodeGroup":{ "name":"DeleteComputeNodeGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteComputeNodeGroupRequest"}, "output":{"shape":"DeleteComputeNodeGroupResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes a compute node group. You must delete all queues associated with the compute node group first.
", "idempotent":true }, "DeleteQueue":{ "name":"DeleteQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteQueueRequest"}, "output":{"shape":"DeleteQueueResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.
", "idempotent":true }, "GetCluster":{ "name":"GetCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetClusterRequest"}, "output":{"shape":"GetClusterResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"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":{ "name":"GetComputeNodeGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetComputeNodeGroupRequest"}, "output":{"shape":"GetComputeNodeGroupResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"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":{ "name":"GetQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueueRequest"}, "output":{"shape":"GetQueueResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.
" }, "ListClusters":{ "name":"ListClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClustersRequest"}, "output":{"shape":"ListClustersResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns a list of running clusters in your account.
" }, "ListComputeNodeGroups":{ "name":"ListComputeNodeGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListComputeNodeGroupsRequest"}, "output":{"shape":"ListComputeNodeGroupsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns a list of all compute node groups associated with a cluster.
" }, "ListQueues":{ "name":"ListQueues", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListQueuesRequest"}, "output":{"shape":"ListQueuesResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns a list of all queues associated with a cluster.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of all tags on an Amazon Web Services PCS resource.
" }, "RegisterComputeNodeGroupInstance":{ "name":"RegisterComputeNodeGroupInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterComputeNodeGroupInstanceRequest"}, "output":{"shape":"RegisterComputeNodeGroupInstanceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"This API action isn't intended for you to use.
Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
", "idempotent":true }, "UpdateComputeNodeGroup":{ "name":"UpdateComputeNodeGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateComputeNodeGroupRequest"}, "output":{"shape":"UpdateComputeNodeGroupResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"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).
", "idempotent":true }, "UpdateQueue":{ "name":"UpdateQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateQueueRequest"}, "output":{"shape":"UpdateQueueResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], "documentation":"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.
", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"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 name that identifies the cluster.
" }, "id":{ "shape":"String", "documentation":"The generated unique ID of the cluster.
" }, "arn":{ "shape":"String", "documentation":"The unique Amazon Resource Name (ARN) of the cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The date and time the resource was created.
" }, "modifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was modified.
" }, "scheduler":{"shape":"Scheduler"}, "size":{ "shape":"Size", "documentation":"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
Additional options related to the Slurm scheduler.
" }, "networking":{"shape":"Networking"}, "endpoints":{ "shape":"Endpoints", "documentation":"The list of endpoints available for interaction with the scheduler.
" }, "errorInfo":{ "shape":"ErrorInfoList", "documentation":"The list of errors that occurred during cluster provisioning.
" } }, "documentation":"The cluster resource and configuration.
" }, "ClusterIdentifier":{ "type":"string", "pattern":"(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,40})" }, "ClusterList":{ "type":"list", "member":{"shape":"ClusterSummary"} }, "ClusterName":{ "type":"string", "max":40, "min":1, "pattern":"(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+" }, "ClusterSlurmConfiguration":{ "type":"structure", "members":{ "scaleDownIdleTimeInSeconds":{ "shape":"ClusterSlurmConfigurationScaleDownIdleTimeInSecondsInteger", "documentation":"The time (in seconds) before an idle node is scaled down.
Default: 600
Additional Slurm-specific configuration that directly maps to Slurm settings.
" }, "authKey":{ "shape":"SlurmAuthKey", "documentation":"The shared Slurm key for authentication, also known as the cluster secret.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" }, "ClusterSlurmConfigurationRequest":{ "type":"structure", "members":{ "scaleDownIdleTimeInSeconds":{ "shape":"ClusterSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger", "documentation":"The time (in seconds) before an idle node is scaled down.
Default: 600
Additional Slurm-specific configuration that directly maps to Slurm settings.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" }, "ClusterSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger":{ "type":"integer", "box":true, "min":1 }, "ClusterSlurmConfigurationScaleDownIdleTimeInSecondsInteger":{ "type":"integer", "box":true, "min":1 }, "ClusterStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED" ] }, "ClusterSummary":{ "type":"structure", "required":[ "name", "id", "arn", "createdAt", "modifiedAt", "status" ], "members":{ "name":{ "shape":"String", "documentation":"The name that identifies the cluster.
" }, "id":{ "shape":"String", "documentation":"The generated unique ID of the cluster.
" }, "arn":{ "shape":"String", "documentation":"The unique Amazon Resource Name (ARN) of the cluster.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was created.
" }, "modifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was modified.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The provisioning status of the cluster.
The provisioning status doesn't indicate the overall health of the cluster.
The object returned by the ListClusters API action.
The name that identifies the compute node group.
" }, "id":{ "shape":"String", "documentation":"The generated unique ID of the compute node group.
" }, "arn":{ "shape":"String", "documentation":"The unique Amazon Resource Name (ARN) of the compute node group.
" }, "clusterId":{ "shape":"String", "documentation":"The ID of the cluster of the compute node group.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was created.
" }, "modifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was modified.
" }, "status":{ "shape":"ComputeNodeGroupStatus", "documentation":"The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" }, "subnetIds":{ "shape":"SubnetIdList", "documentation":"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.
" }, "purchaseOption":{ "shape":"PurchaseOption", "documentation":"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.
" }, "customLaunchTemplate":{"shape":"CustomLaunchTemplate"}, "iamInstanceProfileArn":{ "shape":"InstanceProfileArn", "documentation":"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. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
" }, "spotOptions":{"shape":"SpotOptions"}, "slurmConfiguration":{"shape":"ComputeNodeGroupSlurmConfiguration"}, "errorInfo":{ "shape":"ErrorInfoList", "documentation":"The list of errors that occurred during compute node group provisioning.
" } }, "documentation":"A compute node group associated with a cluster.
" }, "ComputeNodeGroupConfiguration":{ "type":"structure", "members":{ "computeNodeGroupId":{ "shape":"String", "documentation":"The compute node group ID for the compute node group configuration.
" } }, "documentation":"The compute node group configuration for a queue.
" }, "ComputeNodeGroupConfigurationList":{ "type":"list", "member":{"shape":"ComputeNodeGroupConfiguration"} }, "ComputeNodeGroupIdentifier":{ "type":"string", "pattern":"(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,25})" }, "ComputeNodeGroupList":{ "type":"list", "member":{"shape":"ComputeNodeGroupSummary"} }, "ComputeNodeGroupName":{ "type":"string", "max":25, "min":1, "pattern":"(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+" }, "ComputeNodeGroupSlurmConfiguration":{ "type":"structure", "members":{ "slurmCustomSettings":{ "shape":"SlurmCustomSettings", "documentation":"Additional Slurm-specific configuration that directly maps to Slurm settings.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" }, "ComputeNodeGroupSlurmConfigurationRequest":{ "type":"structure", "members":{ "slurmCustomSettings":{ "shape":"SlurmCustomSettings", "documentation":"Additional Slurm-specific configuration that directly maps to Slurm settings.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" }, "ComputeNodeGroupStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED", "DELETED" ] }, "ComputeNodeGroupSummary":{ "type":"structure", "required":[ "name", "id", "arn", "clusterId", "createdAt", "modifiedAt", "status" ], "members":{ "name":{ "shape":"ComputeNodeGroupName", "documentation":"The name that identifies the compute node group.
" }, "id":{ "shape":"String", "documentation":"The generated unique ID of the compute node group.
" }, "arn":{ "shape":"String", "documentation":"The unique Amazon Resource Name (ARN) of the compute node group.
" }, "clusterId":{ "shape":"String", "documentation":"The ID of the cluster of the compute node group.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was created.
" }, "modifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was modified.
" }, "status":{ "shape":"ComputeNodeGroupStatus", "documentation":"The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The object returned by the ListComputeNodeGroups API action.
The unique identifier of the resource that caused the conflict exception.
" }, "resourceType":{ "shape":"String", "documentation":"The type or category of the resource that caused the conflict exception.\"
" } }, "documentation":"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.
A name to identify the cluster. Example: MyCluster
The cluster management and job scheduling software associated with the cluster.
" }, "size":{ "shape":"Size", "documentation":"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 networking configuration used to set up the cluster's control plane.
" }, "slurmConfiguration":{ "shape":"ClusterSlurmConfigurationRequest", "documentation":"Additional options related to the Slurm scheduler.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"RequestTagMap", "documentation":"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.
" } } }, "CreateClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"The cluster resource.
" } } }, "CreateComputeNodeGroupRequest":{ "type":"structure", "required":[ "clusterIdentifier", "computeNodeGroupName", "subnetIds", "customLaunchTemplate", "iamInstanceProfileArn", "scalingConfiguration", "instanceConfigs" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster to create a compute node group in.
" }, "computeNodeGroupName":{ "shape":"ComputeNodeGroupName", "documentation":"A name to identify the cluster. Example: MyCluster
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" }, "subnetIds":{ "shape":"StringList", "documentation":"The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.
" }, "purchaseOption":{ "shape":"PurchaseOption", "documentation":"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.
" }, "customLaunchTemplate":{"shape":"CustomLaunchTemplate"}, "iamInstanceProfileArn":{ "shape":"InstanceProfileArn", "documentation":"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. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
Specifies the boundaries of the compute node group auto scaling.
" }, "instanceConfigs":{ "shape":"InstanceList", "documentation":"A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
" }, "spotOptions":{"shape":"SpotOptions"}, "slurmConfiguration":{ "shape":"ComputeNodeGroupSlurmConfigurationRequest", "documentation":"Additional options related to the Slurm scheduler.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"RequestTagMap", "documentation":"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.
" } } }, "CreateComputeNodeGroupResponse":{ "type":"structure", "members":{ "computeNodeGroup":{"shape":"ComputeNodeGroup"} } }, "CreateQueueRequest":{ "type":"structure", "required":[ "clusterIdentifier", "queueName" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster for which to create a queue.
" }, "queueName":{ "shape":"QueueName", "documentation":"A name to identify the queue.
" }, "computeNodeGroupConfigurations":{ "shape":"ComputeNodeGroupConfigurationList", "documentation":"The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true }, "tags":{ "shape":"RequestTagMap", "documentation":"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.
" } } }, "CreateQueueResponse":{ "type":"structure", "members":{ "queue":{"shape":"Queue"} } }, "CustomLaunchTemplate":{ "type":"structure", "required":[ "id", "version" ], "members":{ "id":{ "shape":"String", "documentation":"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.
" } }, "documentation":"An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
" }, "DeleteClusterRequest":{ "type":"structure", "required":["clusterIdentifier"], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster to delete.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "DeleteClusterResponse":{ "type":"structure", "members":{ } }, "DeleteComputeNodeGroupRequest":{ "type":"structure", "required":[ "clusterIdentifier", "computeNodeGroupIdentifier" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster of the compute node group.
" }, "computeNodeGroupIdentifier":{ "shape":"ComputeNodeGroupIdentifier", "documentation":"The name or ID of the compute node group to delete.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "DeleteComputeNodeGroupResponse":{ "type":"structure", "members":{ } }, "DeleteQueueRequest":{ "type":"structure", "required":[ "clusterIdentifier", "queueIdentifier" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster of the queue.
" }, "queueIdentifier":{ "shape":"QueueIdentifier", "documentation":"The name or ID of the queue to delete.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "DeleteQueueResponse":{ "type":"structure", "members":{ } }, "Endpoint":{ "type":"structure", "required":[ "type", "privateIpAddress", "port" ], "members":{ "type":{ "shape":"EndpointType", "documentation":"Indicates the type of endpoint running at the specific IP address.
" }, "privateIpAddress":{ "shape":"String", "documentation":"The endpoint's private IP address.
Example: 2.2.2.2
The endpoint's public IP address.
Example: 1.1.1.1
The endpoint's connection port number.
Example: 1234
An endpoint available for interaction with the scheduler.
" }, "EndpointType":{ "type":"string", "enum":[ "SLURMCTLD", "SLURMDBD" ] }, "Endpoints":{ "type":"list", "member":{"shape":"Endpoint"} }, "ErrorInfo":{ "type":"structure", "members":{ "code":{ "shape":"String", "documentation":"The short-form error code.
" }, "message":{ "shape":"String", "documentation":"The detailed error information.
" } }, "documentation":"An error that occurred during resource creation.
" }, "ErrorInfoList":{ "type":"list", "member":{"shape":"ErrorInfo"} }, "GetClusterRequest":{ "type":"structure", "required":["clusterIdentifier"], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster of the queue.
" } } }, "GetClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"The cluster resource.
" } } }, "GetComputeNodeGroupRequest":{ "type":"structure", "required":[ "clusterIdentifier", "computeNodeGroupIdentifier" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster.
" }, "computeNodeGroupIdentifier":{ "shape":"ComputeNodeGroupIdentifier", "documentation":"The name or ID of the compute node group.
" } } }, "GetComputeNodeGroupResponse":{ "type":"structure", "members":{ "computeNodeGroup":{"shape":"ComputeNodeGroup"} } }, "GetQueueRequest":{ "type":"structure", "required":[ "clusterIdentifier", "queueIdentifier" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster of the queue.
" }, "queueIdentifier":{ "shape":"QueueIdentifier", "documentation":"The name or ID of the queue.
" } } }, "GetQueueResponse":{ "type":"structure", "members":{ "queue":{"shape":"Queue"} } }, "InstanceConfig":{ "type":"structure", "members":{ "instanceType":{ "shape":"String", "documentation":"The EC2 instance type that Amazon Web Services PCS can provision in the compute node group.
Example: t2.xlarge
An EC2 instance configuration Amazon Web Services PCS uses to launch compute nodes.
" }, "InstanceList":{ "type":"list", "member":{"shape":"InstanceConfig"} }, "InstanceProfileArn":{ "type":"string", "pattern":"arn:aws([a-zA-Z-]{0,10})?:iam::[0-9]{12}:instance-profile/.{1,128}" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"Amazon Web Services PCS can't process your request right now. Try again later.
", "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListClustersRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"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 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 list of clusters.
" }, "nextToken":{ "shape":"String", "documentation":"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 name or ID of the cluster to list compute node groups for.
" }, "nextToken":{ "shape":"String", "documentation":"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 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 list of compute node groups for the cluster.
" }, "nextToken":{ "shape":"String", "documentation":"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 name or ID of the cluster to list queues for.
" }, "nextToken":{ "shape":"String", "documentation":"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 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 list of queues associated with the cluster.
" }, "nextToken":{ "shape":"String", "documentation":"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 Amazon Resource Name (ARN) of the resource for which to list tags.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"ResponseTagMap", "documentation":"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.
" } } }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "Networking":{ "type":"structure", "members":{ "subnetIds":{ "shape":"SubnetIdList", "documentation":"The ID of the subnet where Amazon Web Services PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and Amazon Web Services PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone.
Example: subnet-abcd1234
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)
Outbound rule 2
Protocol: All
Ports: All
Destination: Self
The networking configuration for the cluster's control plane.
" }, "NetworkingRequest":{ "type":"structure", "members":{ "subnetIds":{ "shape":"SubnetIdList", "documentation":"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.
A list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
" } }, "documentation":"The networking configuration for the cluster's control plane.
" }, "PurchaseOption":{ "type":"string", "enum":[ "ONDEMAND", "SPOT" ] }, "Queue":{ "type":"structure", "required":[ "name", "id", "arn", "clusterId", "createdAt", "modifiedAt", "status", "computeNodeGroupConfigurations" ], "members":{ "name":{ "shape":"QueueName", "documentation":"The name that identifies the queue.
" }, "id":{ "shape":"String", "documentation":"The generated unique ID of the queue.
" }, "arn":{ "shape":"String", "documentation":"The unique Amazon Resource Name (ARN) of the queue.
" }, "clusterId":{ "shape":"String", "documentation":"The ID of the cluster of the queue.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was created.
" }, "modifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was modified.
" }, "status":{ "shape":"QueueStatus", "documentation":"The provisioning status of the queue.
The provisioning status doesn't indicate the overall health of the queue.
The list of compute node group configurations associated with the queue. Queues assign jobs to associated compute node groups.
" }, "errorInfo":{ "shape":"ErrorInfoList", "documentation":"The list of errors that occurred during queue provisioning.
" } }, "documentation":"A queue resource.
" }, "QueueIdentifier":{ "type":"string", "pattern":"(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{1,25})" }, "QueueList":{ "type":"list", "member":{"shape":"QueueSummary"} }, "QueueName":{ "type":"string", "max":25, "min":1, "pattern":"(?!pcs_)^(?![A-Za-z0-9]{10}$)[A-Za-z][A-Za-z0-9-]+" }, "QueueStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED" ] }, "QueueSummary":{ "type":"structure", "required":[ "name", "id", "arn", "clusterId", "createdAt", "modifiedAt", "status" ], "members":{ "name":{ "shape":"QueueName", "documentation":"The name that identifies the queue.
" }, "id":{ "shape":"String", "documentation":"The generated unique ID of the queue.
" }, "arn":{ "shape":"String", "documentation":"The unique Amazon Resource Name (ARN) of the queue.
" }, "clusterId":{ "shape":"String", "documentation":"The ID of the cluster of the queue.
" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was created.
" }, "modifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"The date and time the resource was modified.
" }, "status":{ "shape":"QueueStatus", "documentation":"The provisioning status of the queue.
The provisioning status doesn't indicate the overall health of the queue.
The object returned by the ListQueues API action.
The name or ID of the cluster to register the compute node group instance in.
" }, "bootstrapId":{ "shape":"BootstrapId", "documentation":"The client-generated token to allow for retries.
" } } }, "RegisterComputeNodeGroupInstanceResponse":{ "type":"structure", "required":[ "nodeID", "sharedSecret", "endpoints" ], "members":{ "nodeID":{ "shape":"String", "documentation":"The scheduler node ID for this instance.
" }, "sharedSecret":{ "shape":"SharedSecret", "documentation":"For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.
" }, "endpoints":{ "shape":"Endpoints", "documentation":"The list of endpoints available for interaction with the scheduler.
" } } }, "RequestTagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"The unique identifier of the resource that was not found.
" }, "resourceType":{ "shape":"String", "documentation":"The type or category of the resource that was not found.
" } }, "documentation":"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
", "exception":true }, "ResponseTagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, "SBClientToken":{ "type":"string", "max":100, "min":8 }, "ScalingConfiguration":{ "type":"structure", "required":[ "minInstanceCount", "maxInstanceCount" ], "members":{ "minInstanceCount":{ "shape":"ScalingConfigurationMinInstanceCountInteger", "documentation":"The lower bound of the number of instances allowed in the compute fleet.
" }, "maxInstanceCount":{ "shape":"ScalingConfigurationMaxInstanceCountInteger", "documentation":"The upper bound of the number of instances allowed in the compute fleet.
" } }, "documentation":"Specifies the boundaries of the compute node group auto scaling.
" }, "ScalingConfigurationMaxInstanceCountInteger":{ "type":"integer", "box":true, "min":0 }, "ScalingConfigurationMinInstanceCountInteger":{ "type":"integer", "box":true, "min":0 }, "ScalingConfigurationRequest":{ "type":"structure", "required":[ "minInstanceCount", "maxInstanceCount" ], "members":{ "minInstanceCount":{ "shape":"ScalingConfigurationRequestMinInstanceCountInteger", "documentation":"The lower bound of the number of instances allowed in the compute fleet.
" }, "maxInstanceCount":{ "shape":"ScalingConfigurationRequestMaxInstanceCountInteger", "documentation":"The upper bound of the number of instances allowed in the compute fleet.
" } }, "documentation":"Specifies the boundaries of the compute node group auto scaling.
" }, "ScalingConfigurationRequestMaxInstanceCountInteger":{ "type":"integer", "box":true, "min":0 }, "ScalingConfigurationRequestMinInstanceCountInteger":{ "type":"integer", "box":true, "min":0 }, "Scheduler":{ "type":"structure", "required":[ "type", "version" ], "members":{ "type":{ "shape":"SchedulerType", "documentation":"The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
" }, "version":{ "shape":"String", "documentation":"The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
" } }, "documentation":"The cluster management and job scheduling software associated with the cluster.
" }, "SchedulerRequest":{ "type":"structure", "required":[ "type", "version" ], "members":{ "type":{ "shape":"SchedulerType", "documentation":"The software Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
" }, "version":{ "shape":"String", "documentation":"The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling.
" } }, "documentation":"The cluster management and job scheduling software associated with the cluster.
" }, "SchedulerType":{ "type":"string", "enum":["SLURM"] }, "SecurityGroupId":{ "type":"string", "pattern":"sg-\\w{8,17}" }, "SecurityGroupIdList":{ "type":"list", "member":{"shape":"SecurityGroupId"} }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "serviceCode" ], "members":{ "message":{"shape":"String"}, "serviceCode":{ "shape":"String", "documentation":"The service code associated with the quota that was exceeded.
" }, "resourceId":{ "shape":"String", "documentation":"The unique identifier of the resource that caused the quota to be exceeded.
" }, "resourceType":{ "shape":"String", "documentation":"The type or category of the resource that caused the quota to be exceeded.
" }, "quotaCode":{ "shape":"String", "documentation":"The quota code of the service quota that was exceeded.
" } }, "documentation":"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.
The Amazon Resource Name (ARN) of the the shared Slurm key.
" }, "secretVersion":{ "shape":"String", "documentation":"The version of the shared Slurm key.
" } }, "documentation":"The shared Slurm key for authentication, also known as the cluster secret.
" }, "SlurmCustomSetting":{ "type":"structure", "required":[ "parameterName", "parameterValue" ], "members":{ "parameterName":{ "shape":"String", "documentation":"Amazon Web Services PCS supports configuration of the following Slurm parameters:
For clusters
For compute node groups
The values for the configured Slurm settings.
" } }, "documentation":"Additional settings that directly map to Slurm settings.
" }, "SlurmCustomSettings":{ "type":"list", "member":{"shape":"SlurmCustomSetting"} }, "SpotAllocationStrategy":{ "type":"string", "enum":[ "lowest-price", "capacity-optimized", "price-capacity-optimized" ] }, "SpotOptions":{ "type":"structure", "members":{ "allocationStrategy":{ "shape":"SpotAllocationStrategy", "documentation":"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.
" } }, "documentation":"Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
The Amazon Resource Name (ARN) of the resource.
" }, "tags":{ "shape":"RequestTagMap", "documentation":"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.
" } } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"The number of seconds to wait before retrying the request.
" } }, "documentation":"Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
", "exception":true, "retryable":{"throttling":false} }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource.
" }, "tagKeys":{ "shape":"TagKeys", "documentation":"1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.
" } } }, "UpdateComputeNodeGroupRequest":{ "type":"structure", "required":[ "clusterIdentifier", "computeNodeGroupIdentifier" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster of the compute node group.
" }, "computeNodeGroupIdentifier":{ "shape":"ComputeNodeGroupIdentifier", "documentation":"The name or ID of the compute node group.
" }, "amiId":{ "shape":"AmiId", "documentation":"The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
" }, "subnetIds":{ "shape":"StringList", "documentation":"The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.
" }, "customLaunchTemplate":{"shape":"CustomLaunchTemplate"}, "purchaseOption":{ "shape":"PurchaseOption", "documentation":"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.
" }, "spotOptions":{"shape":"SpotOptions"}, "scalingConfiguration":{ "shape":"ScalingConfigurationRequest", "documentation":"Specifies the boundaries of the compute node group auto scaling.
" }, "iamInstanceProfileArn":{ "shape":"InstanceProfileArn", "documentation":"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. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
Additional options related to the Slurm scheduler.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "UpdateComputeNodeGroupResponse":{ "type":"structure", "members":{ "computeNodeGroup":{"shape":"ComputeNodeGroup"} } }, "UpdateComputeNodeGroupSlurmConfigurationRequest":{ "type":"structure", "members":{ "slurmCustomSettings":{ "shape":"SlurmCustomSettings", "documentation":"Additional Slurm-specific configuration that directly maps to Slurm settings.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" }, "UpdateQueueRequest":{ "type":"structure", "required":[ "clusterIdentifier", "queueIdentifier" ], "members":{ "clusterIdentifier":{ "shape":"ClusterIdentifier", "documentation":"The name or ID of the cluster of the queue.
" }, "queueIdentifier":{ "shape":"QueueIdentifier", "documentation":"The name or ID of the queue.
" }, "computeNodeGroupConfigurations":{ "shape":"ComputeNodeGroupConfigurationList", "documentation":"The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.
" }, "clientToken":{ "shape":"SBClientToken", "documentation":"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.
", "idempotencyToken":true } } }, "UpdateQueueResponse":{ "type":"structure", "members":{ "queue":{"shape":"Queue"} } }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"The specific reason or cause of the validation error.
" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"A list of fields or properties that failed validation.
" } }, "documentation":"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.
The name of the exception.
" }, "message":{ "shape":"String", "documentation":"The message body of the exception.
" } }, "documentation":"Stores information about a field in a request that caused an exception.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "other" ] } }, "documentation":"Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.
" }