PCS

import { PCS } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/pcs.ts?docs=full";

class PCS {

constructor(apiFactory: client.ApiFactory);

async createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>;

async createComputeNodeGroup(params: CreateComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<CreateComputeNodeGroupResponse>;

async createQueue(params: CreateQueueRequest, opts?: client.RequestOptions): Promise<CreateQueueResponse>;

async deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<void>;

async deleteComputeNodeGroup(params: DeleteComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<void>;

async deleteQueue(params: DeleteQueueRequest, opts?: client.RequestOptions): Promise<void>;

async getCluster(params: GetClusterRequest, opts?: client.RequestOptions): Promise<GetClusterResponse>;

async getComputeNodeGroup(params: GetComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<GetComputeNodeGroupResponse>;

async getQueue(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>;

async listClusters(params?: ListClustersRequest, opts?: client.RequestOptions): Promise<ListClustersResponse>;

async listComputeNodeGroups(params: ListComputeNodeGroupsRequest, opts?: client.RequestOptions): Promise<ListComputeNodeGroupsResponse>;

async listQueues(params: ListQueuesRequest, opts?: client.RequestOptions): Promise<ListQueuesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async registerComputeNodeGroupInstance(params: RegisterComputeNodeGroupInstanceRequest, opts?: client.RequestOptions): Promise<RegisterComputeNodeGroupInstanceResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateComputeNodeGroup(params: UpdateComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<UpdateComputeNodeGroupResponse>;

async updateQueue(params: UpdateQueueRequest, opts?: client.RequestOptions): Promise<UpdateQueueResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new PCS(apiFactory: client.ApiFactory)

[src]

§Methods

createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>

[src]

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.

Note: 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.

createComputeNodeGroup(params: CreateComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<CreateComputeNodeGroupResponse>

[src]

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(params: CreateQueueRequest, opts?: client.RequestOptions): Promise<CreateQueueResponse>

[src]

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(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<void>

[src]

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(params: DeleteComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteQueue(params: DeleteQueueRequest, opts?: client.RequestOptions): Promise<void>

[src]

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(params: GetClusterRequest, opts?: client.RequestOptions): Promise<GetClusterResponse>

[src]

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(params: GetComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<GetComputeNodeGroupResponse>

[src]

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(params: GetQueueRequest, opts?: client.RequestOptions): Promise<GetQueueResponse>

[src]

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

listClusters(params?: ListClustersRequest, opts?: client.RequestOptions): Promise<ListClustersResponse>

[src]

Returns a list of running clusters in your account.

listComputeNodeGroups(params: ListComputeNodeGroupsRequest, opts?: client.RequestOptions): Promise<ListComputeNodeGroupsResponse>

[src]

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

listQueues(params: ListQueuesRequest, opts?: client.RequestOptions): Promise<ListQueuesResponse>

[src]

Returns a list of all queues associated with a cluster.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

registerComputeNodeGroupInstance(params: RegisterComputeNodeGroupInstanceRequest, opts?: client.RequestOptions): Promise<RegisterComputeNodeGroupInstanceResponse>

[src]

! IMPORTANT: ! 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(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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(params: UpdateComputeNodeGroupRequest, opts?: client.RequestOptions): Promise<UpdateComputeNodeGroupResponse>

[src]

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(params: UpdateQueueRequest, opts?: client.RequestOptions): Promise<UpdateQueueResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]