pcs/aws.sdk.kotlin.services.pcs

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createCluster

inline suspend fun PcsClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

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.

createComputeNodeGroup

inline suspend fun PcsClient.createComputeNodeGroup(crossinline block: CreateComputeNodeGroupRequest.Builder.() -> Unit): CreateComputeNodeGroupResponse

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.

createQueue

inline suspend fun PcsClient.createQueue(crossinline block: CreateQueueRequest.Builder.() -> Unit): CreateQueueResponse

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

inline suspend fun PcsClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

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

inline suspend fun PcsClient.deleteComputeNodeGroup(crossinline block: DeleteComputeNodeGroupRequest.Builder.() -> Unit): DeleteComputeNodeGroupResponse

Deletes a compute node group. You must delete all queues associated with the compute node group first.

deleteQueue

inline suspend fun PcsClient.deleteQueue(crossinline block: DeleteQueueRequest.Builder.() -> Unit): DeleteQueueResponse

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.

getCluster

inline suspend fun PcsClient.getCluster(crossinline block: GetClusterRequest.Builder.() -> Unit): GetClusterResponse

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

inline suspend fun PcsClient.getComputeNodeGroup(crossinline block: GetComputeNodeGroupRequest.Builder.() -> Unit): GetComputeNodeGroupResponse

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

inline suspend fun PcsClient.getQueue(crossinline block: GetQueueRequest.Builder.() -> Unit): GetQueueResponse

Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.

listClusters

inline suspend fun PcsClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

Returns a list of running clusters in your account.

listComputeNodeGroups

inline suspend fun PcsClient.listComputeNodeGroups(crossinline block: ListComputeNodeGroupsRequest.Builder.() -> Unit): ListComputeNodeGroupsResponse

Returns a list of all compute node groups associated with a cluster.

listQueues

inline suspend fun PcsClient.listQueues(crossinline block: ListQueuesRequest.Builder.() -> Unit): ListQueuesResponse

Returns a list of all queues associated with a cluster.

listTagsForResource

inline suspend fun PcsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of all tags on an Amazon Web Services PCS resource.

registerComputeNodeGroupInstance

inline suspend fun PcsClient.registerComputeNodeGroupInstance(crossinline block: RegisterComputeNodeGroupInstanceRequest.Builder.() -> Unit): RegisterComputeNodeGroupInstanceResponse

This API action isn't intended for you to use.

tagResource

inline suspend fun PcsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun PcsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

updateComputeNodeGroup

inline suspend fun PcsClient.updateComputeNodeGroup(crossinline block: UpdateComputeNodeGroupRequest.Builder.() -> Unit): UpdateComputeNodeGroupResponse

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

inline suspend fun PcsClient.updateQueue(crossinline block: UpdateQueueRequest.Builder.() -> Unit): UpdateQueueResponse

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.

withConfig

fun PcsClient.withConfig(block: PcsClient.Config.Builder.() -> Unit): PcsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.