Smaws_Client_PCS (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_validation_exception_field : 
  message:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.validation_exception_field

val make_update_slurm_rest_request : 
  ?mode:Types.slurm_rest_mode ->
  unit ->
  Types.update_slurm_rest_request

val make_update_scheduler_request : 
  version:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.update_scheduler_request

val make_slurm_custom_setting : 
  parameter_value:Smaws_Lib.Smithy_api.Types.string_ ->
  parameter_name:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.slurm_custom_setting

val make_update_queue_slurm_configuration_request : 
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  unit ->
  Types.update_queue_slurm_configuration_request

val make_compute_node_group_configuration : 
  ?compute_node_group_id:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.compute_node_group_configuration

val make_queue_slurm_configuration : 
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  unit ->
  Types.queue_slurm_configuration

val make_error_info : 
  ?message:Smaws_Lib.Smithy_api.Types.string_ ->
  ?code:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.error_info

val make_queue : 
  ?error_info:Types.error_info_list ->
  ?slurm_configuration:Types.queue_slurm_configuration ->
  compute_node_group_configurations:Types.compute_node_group_configuration_list ->
  status:Types.queue_status ->
  modified_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  cluster_id:Smaws_Lib.Smithy_api.Types.string_ ->
  arn:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Types.queue_name ->
  unit ->
  Types.queue

val make_update_queue_response : 
  ?queue:Types.queue ->
  unit ->
  Types.update_queue_response

val make_update_queue_request : 
  ?client_token:Types.sb_client_token ->
  ?slurm_configuration:Types.update_queue_slurm_configuration_request ->
  ?compute_node_group_configurations:
    Types.compute_node_group_configuration_list ->
  queue_identifier:Types.queue_identifier ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.update_queue_request

val make_update_compute_node_group_slurm_configuration_request : 
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  ?scale_down_idle_time_in_seconds:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.update_compute_node_group_slurm_configuration_request

val make_custom_launch_template : 
  version:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.custom_launch_template

val make_scaling_configuration : 
  max_instance_count:Smaws_Lib.Smithy_api.Types.integer ->
  min_instance_count:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.scaling_configuration

val make_instance_config : 
  ?instance_type:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.instance_config

val make_spot_options : 
  ?allocation_strategy:Types.spot_allocation_strategy ->
  unit ->
  Types.spot_options

val make_compute_node_group_slurm_configuration : 
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  ?scale_down_idle_time_in_seconds:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.compute_node_group_slurm_configuration

val make_compute_node_group : 
  ?error_info:Types.error_info_list ->
  ?slurm_configuration:Types.compute_node_group_slurm_configuration ->
  ?spot_options:Types.spot_options ->
  ?purchase_option:Types.purchase_option ->
  ?ami_id:Types.ami_id ->
  instance_configs:Types.instance_list ->
  scaling_configuration:Types.scaling_configuration ->
  iam_instance_profile_arn:Types.instance_profile_arn ->
  custom_launch_template:Types.custom_launch_template ->
  subnet_ids:Types.subnet_id_list ->
  status:Types.compute_node_group_status ->
  modified_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  cluster_id:Smaws_Lib.Smithy_api.Types.string_ ->
  arn:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Types.compute_node_group_name ->
  unit ->
  Types.compute_node_group

val make_update_compute_node_group_response : 
  ?compute_node_group:Types.compute_node_group ->
  unit ->
  Types.update_compute_node_group_response

val make_scaling_configuration_request : 
  max_instance_count:Smaws_Lib.Smithy_api.Types.integer ->
  min_instance_count:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.scaling_configuration_request

val make_update_compute_node_group_request : 
  ?client_token:Types.sb_client_token ->
  ?slurm_configuration:
    Types.update_compute_node_group_slurm_configuration_request ->
  ?iam_instance_profile_arn:Types.instance_profile_arn ->
  ?scaling_configuration:Types.scaling_configuration_request ->
  ?spot_options:Types.spot_options ->
  ?purchase_option:Types.purchase_option ->
  ?custom_launch_template:Types.custom_launch_template ->
  ?subnet_ids:Types.string_list ->
  ?ami_id:Types.ami_id ->
  compute_node_group_identifier:Types.compute_node_group_identifier ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.update_compute_node_group_request

val make_slurmdbd_custom_setting : 
  parameter_value:Smaws_Lib.Smithy_api.Types.string_ ->
  parameter_name:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.slurmdbd_custom_setting

val make_cgroup_custom_setting : 
  parameter_value:Smaws_Lib.Smithy_api.Types.string_ ->
  parameter_name:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.cgroup_custom_setting

val make_update_accounting_request : 
  ?mode:Types.accounting_mode ->
  ?default_purge_time_in_days:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.update_accounting_request

val make_update_cluster_slurm_configuration_request : 
  ?slurm_rest:Types.update_slurm_rest_request ->
  ?accounting:Types.update_accounting_request ->
  ?cgroup_custom_settings:Types.cgroup_custom_settings ->
  ?slurmdbd_custom_settings:Types.slurmdbd_custom_settings ->
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  ?scale_down_idle_time_in_seconds:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.update_cluster_slurm_configuration_request

val make_scheduler : 
  version:Smaws_Lib.Smithy_api.Types.string_ ->
  type_:Types.scheduler_type ->
  unit ->
  Types.scheduler

val make_slurm_auth_key : 
  secret_version:Smaws_Lib.Smithy_api.Types.string_ ->
  secret_arn:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.slurm_auth_key

val make_jwt_key : 
  secret_version:Smaws_Lib.Smithy_api.Types.string_ ->
  secret_arn:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.jwt_key

val make_jwt_auth : ?jwt_key:Types.jwt_key -> unit -> Types.jwt_auth

val make_accounting : 
  ?default_purge_time_in_days:Smaws_Lib.Smithy_api.Types.integer ->
  mode:Types.accounting_mode ->
  unit ->
  Types.accounting

val make_slurm_rest : mode:Types.slurm_rest_mode -> unit -> Types.slurm_rest

val make_cluster_slurm_configuration : 
  ?slurm_rest:Types.slurm_rest ->
  ?accounting:Types.accounting ->
  ?jwt_auth:Types.jwt_auth ->
  ?auth_key:Types.slurm_auth_key ->
  ?cgroup_custom_settings:Types.cgroup_custom_settings ->
  ?slurmdbd_custom_settings:Types.slurmdbd_custom_settings ->
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  ?scale_down_idle_time_in_seconds:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.cluster_slurm_configuration

val make_networking : 
  ?network_type:Types.network_type ->
  ?security_group_ids:Types.security_group_id_list ->
  ?subnet_ids:Types.subnet_id_list ->
  unit ->
  Types.networking

val make_endpoint : 
  ?ipv6_address:Smaws_Lib.Smithy_api.Types.string_ ->
  ?public_ip_address:Smaws_Lib.Smithy_api.Types.string_ ->
  port:Smaws_Lib.Smithy_api.Types.string_ ->
  private_ip_address:Smaws_Lib.Smithy_api.Types.string_ ->
  type_:Types.endpoint_type ->
  unit ->
  Types.endpoint

val make_cluster : 
  ?error_info:Types.error_info_list ->
  ?endpoints:Types.endpoints ->
  ?slurm_configuration:Types.cluster_slurm_configuration ->
  networking:Types.networking ->
  size:Types.size ->
  scheduler:Types.scheduler ->
  modified_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  status:Types.cluster_status ->
  arn:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.cluster

val make_update_cluster_response : 
  ?cluster:Types.cluster ->
  unit ->
  Types.update_cluster_response

val make_update_cluster_request : 
  ?scheduler:Types.update_scheduler_request ->
  ?slurm_configuration:Types.update_cluster_slurm_configuration_request ->
  ?client_token:Types.sb_client_token ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.update_cluster_request

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  tag_keys:Types.tag_keys ->
  resource_arn:Types.arn ->
  unit ->
  Types.untag_resource_request

val make_tag_resource_response : unit -> unit

val make_tag_resource_request : 
  tags:Types.request_tag_map ->
  resource_arn:Types.arn ->
  unit ->
  Types.tag_resource_request

val make_slurm_rest_request : 
  mode:Types.slurm_rest_mode ->
  unit ->
  Types.slurm_rest_request

val make_scheduler_request : 
  version:Smaws_Lib.Smithy_api.Types.string_ ->
  type_:Types.scheduler_type ->
  unit ->
  Types.scheduler_request

val make_register_compute_node_group_instance_response : 
  endpoints:Types.endpoints ->
  shared_secret:Types.shared_secret ->
  node_i_d:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.register_compute_node_group_instance_response

val make_register_compute_node_group_instance_request : 
  bootstrap_id:Types.bootstrap_id ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.register_compute_node_group_instance_request

val make_queue_summary : 
  status:Types.queue_status ->
  modified_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  cluster_id:Smaws_Lib.Smithy_api.Types.string_ ->
  arn:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Types.queue_name ->
  unit ->
  Types.queue_summary

val make_queue_slurm_configuration_request : 
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  unit ->
  Types.queue_slurm_configuration_request

val make_networking_request : 
  ?network_type:Types.network_type ->
  ?security_group_ids:Types.security_group_id_list ->
  ?subnet_ids:Types.subnet_id_list ->
  unit ->
  Types.networking_request

val make_list_tags_for_resource_response : 
  ?tags:Types.response_tag_map ->
  unit ->
  Types.list_tags_for_resource_response

val make_list_tags_for_resource_request : 
  resource_arn:Types.arn ->
  unit ->
  Types.list_tags_for_resource_request

val make_list_queues_response : 
  ?next_token:Smaws_Lib.Smithy_api.Types.string_ ->
  queues:Types.queue_list ->
  unit ->
  Types.list_queues_response

val make_list_queues_request : 
  ?max_results:Types.max_results ->
  ?next_token:Smaws_Lib.Smithy_api.Types.string_ ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.list_queues_request

val make_compute_node_group_summary : 
  status:Types.compute_node_group_status ->
  modified_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  cluster_id:Smaws_Lib.Smithy_api.Types.string_ ->
  arn:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Types.compute_node_group_name ->
  unit ->
  Types.compute_node_group_summary

val make_list_compute_node_groups_response : 
  ?next_token:Smaws_Lib.Smithy_api.Types.string_ ->
  compute_node_groups:Types.compute_node_group_list ->
  unit ->
  Types.list_compute_node_groups_response

val make_list_compute_node_groups_request : 
  ?max_results:Types.max_results ->
  ?next_token:Smaws_Lib.Smithy_api.Types.string_ ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.list_compute_node_groups_request

val make_cluster_summary : 
  status:Types.cluster_status ->
  modified_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  arn:Smaws_Lib.Smithy_api.Types.string_ ->
  id:Smaws_Lib.Smithy_api.Types.string_ ->
  name:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.cluster_summary

val make_list_clusters_response : 
  ?next_token:Smaws_Lib.Smithy_api.Types.string_ ->
  clusters:Types.cluster_list ->
  unit ->
  Types.list_clusters_response

val make_list_clusters_request : 
  ?max_results:Types.max_results ->
  ?next_token:Smaws_Lib.Smithy_api.Types.string_ ->
  unit ->
  Types.list_clusters_request

val make_get_queue_response : 
  ?queue:Types.queue ->
  unit ->
  Types.get_queue_response

val make_get_queue_request : 
  queue_identifier:Types.queue_identifier ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.get_queue_request

val make_get_compute_node_group_response : 
  ?compute_node_group:Types.compute_node_group ->
  unit ->
  Types.get_compute_node_group_response

val make_get_compute_node_group_request : 
  compute_node_group_identifier:Types.compute_node_group_identifier ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.get_compute_node_group_request

val make_get_cluster_response : 
  ?cluster:Types.cluster ->
  unit ->
  Types.get_cluster_response

val make_get_cluster_request : 
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.get_cluster_request

val make_delete_queue_response : unit -> unit

val make_delete_queue_request : 
  ?client_token:Types.sb_client_token ->
  queue_identifier:Types.queue_identifier ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.delete_queue_request

val make_delete_compute_node_group_response : unit -> unit

val make_delete_compute_node_group_request : 
  ?client_token:Types.sb_client_token ->
  compute_node_group_identifier:Types.compute_node_group_identifier ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.delete_compute_node_group_request

val make_delete_cluster_response : unit -> unit

val make_delete_cluster_request : 
  ?client_token:Types.sb_client_token ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.delete_cluster_request

val make_create_queue_response : 
  ?queue:Types.queue ->
  unit ->
  Types.create_queue_response

val make_create_queue_request : 
  ?tags:Types.request_tag_map ->
  ?client_token:Types.sb_client_token ->
  ?slurm_configuration:Types.queue_slurm_configuration_request ->
  ?compute_node_group_configurations:
    Types.compute_node_group_configuration_list ->
  queue_name:Types.queue_name ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.create_queue_request

val make_create_compute_node_group_response : 
  ?compute_node_group:Types.compute_node_group ->
  unit ->
  Types.create_compute_node_group_response

val make_compute_node_group_slurm_configuration_request : 
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  ?scale_down_idle_time_in_seconds:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.compute_node_group_slurm_configuration_request

val make_create_compute_node_group_request : 
  ?tags:Types.request_tag_map ->
  ?client_token:Types.sb_client_token ->
  ?slurm_configuration:Types.compute_node_group_slurm_configuration_request ->
  ?spot_options:Types.spot_options ->
  ?purchase_option:Types.purchase_option ->
  ?ami_id:Types.ami_id ->
  instance_configs:Types.instance_list ->
  scaling_configuration:Types.scaling_configuration_request ->
  iam_instance_profile_arn:Types.instance_profile_arn ->
  custom_launch_template:Types.custom_launch_template ->
  subnet_ids:Types.string_list ->
  compute_node_group_name:Types.compute_node_group_name ->
  cluster_identifier:Types.cluster_identifier ->
  unit ->
  Types.create_compute_node_group_request

val make_create_cluster_response : 
  ?cluster:Types.cluster ->
  unit ->
  Types.create_cluster_response

val make_accounting_request : 
  ?default_purge_time_in_days:Smaws_Lib.Smithy_api.Types.integer ->
  mode:Types.accounting_mode ->
  unit ->
  Types.accounting_request

val make_cluster_slurm_configuration_request : 
  ?slurm_rest:Types.slurm_rest_request ->
  ?accounting:Types.accounting_request ->
  ?cgroup_custom_settings:Types.cgroup_custom_settings ->
  ?slurmdbd_custom_settings:Types.slurmdbd_custom_settings ->
  ?slurm_custom_settings:Types.slurm_custom_settings ->
  ?scale_down_idle_time_in_seconds:Smaws_Lib.Smithy_api.Types.integer ->
  unit ->
  Types.cluster_slurm_configuration_request

val make_create_cluster_request : 
  ?tags:Types.request_tag_map ->
  ?client_token:Types.sb_client_token ->
  ?slurm_configuration:Types.cluster_slurm_configuration_request ->
  networking:Types.networking_request ->
  size:Types.size ->
  scheduler:Types.scheduler_request ->
  cluster_name:Types.cluster_name ->
  unit ->
  Types.create_cluster_request

Operations

module CreateCluster : sig ... end

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.

module CreateComputeNodeGroup : sig ... end

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.

module CreateQueue : sig ... end

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.

module DeleteCluster : sig ... end

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.

module DeleteComputeNodeGroup : sig ... end

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

module DeleteQueue : sig ... end

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.

module GetCluster : sig ... end

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.

module GetComputeNodeGroup : sig ... end

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.

module GetQueue : sig ... end

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

module ListClusters : sig ... end

Returns a list of running clusters in your account.

module ListComputeNodeGroups : sig ... end

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

module ListQueues : sig ... end

Returns a list of all queues associated with a cluster.

module ListTagsForResource : sig ... end

Returns a list of all tags on an PCS resource.

module RegisterComputeNodeGroupInstance : sig ... end

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

module TagResource : sig ... end

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.

module UntagResource : sig ... end

Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.

module UpdateCluster : sig ... end

Updates a cluster configuration. You can upgrade the Slurm version, modify scheduler settings, and update accounting configuration for an existing cluster. For more information about upgrading the Slurm version, see Upgrading the Slurm version on a cluster in the PCS User Guide.

module UpdateComputeNodeGroup : sig ... end

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).

module UpdateQueue : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end