Class: Aws::PCS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PCS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb
Overview
An API client for PCS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PCS::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a cluster in your account.
-
#create_compute_node_group(params = {}) ⇒ Types::CreateComputeNodeGroupResponse
Creates a managed set of compute nodes.
-
#create_queue(params = {}) ⇒ Types::CreateQueueResponse
Creates a job queue.
-
#delete_cluster(params = {}) ⇒ Struct
Deletes a cluster and all its linked resources.
-
#delete_compute_node_group(params = {}) ⇒ Struct
Deletes a compute node group.
-
#delete_queue(params = {}) ⇒ Struct
Deletes a job queue.
-
#get_cluster(params = {}) ⇒ Types::GetClusterResponse
Returns detailed information about a running cluster in your account.
-
#get_compute_node_group(params = {}) ⇒ Types::GetComputeNodeGroupResponse
Returns detailed information about a compute node group.
-
#get_queue(params = {}) ⇒ Types::GetQueueResponse
Returns detailed information about a queue.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of running clusters in your account.
-
#list_compute_node_groups(params = {}) ⇒ Types::ListComputeNodeGroupsResponse
Returns a list of all compute node groups associated with a cluster.
-
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Returns a list of all queues associated with a cluster.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all tags on an Amazon Web Services PCS resource.
-
#register_compute_node_group_instance(params = {}) ⇒ Types::RegisterComputeNodeGroupInstanceResponse
This API action isn't intended for you to use.
-
#tag_resource(params = {}) ⇒ Struct
Adds or edits tags on an Amazon Web Services PCS resource.
-
#untag_resource(params = {}) ⇒ Struct
Deletes tags from an Amazon Web Services PCS resource.
-
#update_compute_node_group(params = {}) ⇒ Types::UpdateComputeNodeGroupResponse
Updates a compute node group.
-
#update_queue(params = {}) ⇒ Types::UpdateQueueResponse
Updates the compute node group configuration of a queue.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
474 475 476 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 474 def initialize(*args) super end |
Instance Method Details
#create_cluster(params = {}) ⇒ Types::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.
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.
601 602 603 604 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 601 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_compute_node_group(params = {}) ⇒ Types::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.
773 774 775 776 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 773 def create_compute_node_group(params = {}, = {}) req = build_request(:create_compute_node_group, params) req.send_request() end |
#create_queue(params = {}) ⇒ Types::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.
847 848 849 850 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 847 def create_queue(params = {}, = {}) req = build_request(:create_queue, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Struct
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.
884 885 886 887 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 884 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_compute_node_group(params = {}) ⇒ Struct
Deletes a compute node group. You must delete all queues associated with the compute node group first.
924 925 926 927 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 924 def delete_compute_node_group(params = {}, = {}) req = build_request(:delete_compute_node_group, params) req.send_request() end |
#delete_queue(params = {}) ⇒ Struct
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.
965 966 967 968 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 965 def delete_queue(params = {}, = {}) req = build_request(:delete_queue, params) req.send_request() end |
#get_cluster(params = {}) ⇒ Types::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.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1021 def get_cluster(params = {}, = {}) req = build_request(:get_cluster, params) req.send_request() end |
#get_compute_node_group(params = {}) ⇒ Types::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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1079 def get_compute_node_group(params = {}, = {}) req = build_request(:get_compute_node_group, params) req.send_request() end |
#get_queue(params = {}) ⇒ Types::GetQueueResponse
Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.
1123 1124 1125 1126 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1123 def get_queue(params = {}, = {}) req = build_request(:get_queue, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of running clusters in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1173 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_compute_node_groups(params = {}) ⇒ Types::ListComputeNodeGroupsResponse
Returns a list of all compute node groups associated with a cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1228 def list_compute_node_groups(params = {}, = {}) req = build_request(:list_compute_node_groups, params) req.send_request() end |
#list_queues(params = {}) ⇒ Types::ListQueuesResponse
Returns a list of all queues associated with a cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1283 1284 1285 1286 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1283 def list_queues(params = {}, = {}) req = build_request(:list_queues, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of all tags on an Amazon Web Services PCS resource.
1312 1313 1314 1315 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1312 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_compute_node_group_instance(params = {}) ⇒ Types::RegisterComputeNodeGroupInstanceResponse
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.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1356 def register_compute_node_group_instance(params = {}, = {}) req = build_request(:register_compute_node_group_instance, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1389 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
1418 1419 1420 1421 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1418 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_compute_node_group(params = {}) ⇒ Types::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).
1561 1562 1563 1564 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1561 def update_compute_node_group(params = {}, = {}) req = build_request(:update_compute_node_group, params) req.send_request() end |
#update_queue(params = {}) ⇒ Types::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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/client.rb', line 1627 def update_queue(params = {}, = {}) req = build_request(:update_queue, params) req.send_request() end |