aws-sdk-pcs 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1608 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
29
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
30
+ require 'aws-sdk-core/plugins/http_checksum.rb'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
+ require 'aws-sdk-core/plugins/request_compression.rb'
33
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
34
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/sign.rb'
36
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
37
+
38
+ Aws::Plugins::GlobalConfiguration.add_identifier(:pcs)
39
+
40
+ module Aws::PCS
41
+ # An API client for PCS. To construct a client, you need to configure a `:region` and `:credentials`.
42
+ #
43
+ # client = Aws::PCS::Client.new(
44
+ # region: region_name,
45
+ # credentials: credentials,
46
+ # # ...
47
+ # )
48
+ #
49
+ # For details on configuring region and credentials see
50
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
51
+ #
52
+ # See {#initialize} for a full list of supported configuration options.
53
+ class Client < Seahorse::Client::Base
54
+
55
+ include Aws::ClientStubs
56
+
57
+ @identifier = :pcs
58
+
59
+ set_api(ClientApi::API)
60
+
61
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
62
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
63
+ add_plugin(Aws::Plugins::Logging)
64
+ add_plugin(Aws::Plugins::ParamConverter)
65
+ add_plugin(Aws::Plugins::ParamValidator)
66
+ add_plugin(Aws::Plugins::UserAgent)
67
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
68
+ add_plugin(Aws::Plugins::RetryErrors)
69
+ add_plugin(Aws::Plugins::GlobalConfiguration)
70
+ add_plugin(Aws::Plugins::RegionalEndpoint)
71
+ add_plugin(Aws::Plugins::EndpointDiscovery)
72
+ add_plugin(Aws::Plugins::EndpointPattern)
73
+ add_plugin(Aws::Plugins::ResponsePaging)
74
+ add_plugin(Aws::Plugins::StubResponses)
75
+ add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
77
+ add_plugin(Aws::Plugins::JsonvalueConverter)
78
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
79
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
80
+ add_plugin(Aws::Plugins::TransferEncoding)
81
+ add_plugin(Aws::Plugins::HttpChecksum)
82
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
83
+ add_plugin(Aws::Plugins::RequestCompression)
84
+ add_plugin(Aws::Plugins::DefaultsMode)
85
+ add_plugin(Aws::Plugins::RecursionDetection)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
88
+ add_plugin(Aws::PCS::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials. This can be an instance of any one of the
99
+ # following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following
128
+ # locations will be searched for credentials:
129
+ #
130
+ # * `Aws.config[:credentials]`
131
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
132
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
136
+ # are very aggressive. Construct and pass an instance of
137
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
138
+ # enable retries and extended timeouts. Instance profile credential
139
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
140
+ # to true.
141
+ #
142
+ # @option options [required, String] :region
143
+ # The AWS region to connect to. The configured `:region` is
144
+ # used to determine the service `:endpoint`. When not passed,
145
+ # a default `:region` is searched for in the following locations:
146
+ #
147
+ # * `Aws.config[:region]`
148
+ # * `ENV['AWS_REGION']`
149
+ # * `ENV['AMAZON_REGION']`
150
+ # * `ENV['AWS_DEFAULT_REGION']`
151
+ # * `~/.aws/credentials`
152
+ # * `~/.aws/config`
153
+ #
154
+ # @option options [String] :access_key_id
155
+ #
156
+ # @option options [Boolean] :active_endpoint_cache (false)
157
+ # When set to `true`, a thread polling for endpoints will be running in
158
+ # the background every 60 secs (default). Defaults to `false`.
159
+ #
160
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
161
+ # Used only in `adaptive` retry mode. When true, the request will sleep
162
+ # until there is sufficent client side capacity to retry the request.
163
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
164
+ # not retry instead of sleeping.
165
+ #
166
+ # @option options [Boolean] :client_side_monitoring (false)
167
+ # When `true`, client-side metrics will be collected for all API requests from
168
+ # this client.
169
+ #
170
+ # @option options [String] :client_side_monitoring_client_id ("")
171
+ # Allows you to provide an identifier for this client which will be attached to
172
+ # all generated client side metrics. Defaults to an empty string.
173
+ #
174
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
175
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
176
+ # side monitoring agent is running on, where client metrics will be published via UDP.
177
+ #
178
+ # @option options [Integer] :client_side_monitoring_port (31000)
179
+ # Required for publishing client metrics. The port that the client side monitoring
180
+ # agent is running on, where client metrics will be published via UDP.
181
+ #
182
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
183
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
184
+ # will use the Client Side Monitoring Agent Publisher.
185
+ #
186
+ # @option options [Boolean] :convert_params (true)
187
+ # When `true`, an attempt is made to coerce request parameters into
188
+ # the required types.
189
+ #
190
+ # @option options [Boolean] :correct_clock_skew (true)
191
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
192
+ # a clock skew correction and retry requests with skewed client clocks.
193
+ #
194
+ # @option options [String] :defaults_mode ("legacy")
195
+ # See {Aws::DefaultsModeConfiguration} for a list of the
196
+ # accepted modes and the configuration defaults that are included.
197
+ #
198
+ # @option options [Boolean] :disable_host_prefix_injection (false)
199
+ # Set to true to disable SDK automatically adding host prefix
200
+ # to default service endpoint when available.
201
+ #
202
+ # @option options [Boolean] :disable_request_compression (false)
203
+ # When set to 'true' the request body will not be compressed
204
+ # for supported operations.
205
+ #
206
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
207
+ # Normally you should not configure the `:endpoint` option
208
+ # directly. This is normally constructed from the `:region`
209
+ # option. Configuring `:endpoint` is normally reserved for
210
+ # connecting to test or custom endpoints. The endpoint should
211
+ # be a URI formatted like:
212
+ #
213
+ # 'http://example.com'
214
+ # 'https://example.com'
215
+ # 'http://example.com:123'
216
+ #
217
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
218
+ # Used for the maximum size limit of the LRU cache storing endpoints data
219
+ # for endpoint discovery enabled operations. Defaults to 1000.
220
+ #
221
+ # @option options [Integer] :endpoint_cache_max_threads (10)
222
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
223
+ #
224
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
225
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
226
+ # Use this option to config the time interval in seconds for making
227
+ # requests fetching endpoints information. Defaults to 60 sec.
228
+ #
229
+ # @option options [Boolean] :endpoint_discovery (false)
230
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
231
+ #
232
+ # @option options [Boolean] :ignore_configured_endpoint_urls
233
+ # Setting to true disables use of endpoint URLs provided via environment
234
+ # variables and the shared configuration file.
235
+ #
236
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
237
+ # The log formatter.
238
+ #
239
+ # @option options [Symbol] :log_level (:info)
240
+ # The log level to send messages to the `:logger` at.
241
+ #
242
+ # @option options [Logger] :logger
243
+ # The Logger instance to send log messages to. If this option
244
+ # is not set, logging will be disabled.
245
+ #
246
+ # @option options [Integer] :max_attempts (3)
247
+ # An integer representing the maximum number attempts that will be made for
248
+ # a single request, including the initial attempt. For example,
249
+ # setting this value to 5 will result in a request being retried up to
250
+ # 4 times. Used in `standard` and `adaptive` retry modes.
251
+ #
252
+ # @option options [String] :profile ("default")
253
+ # Used when loading credentials from the shared credentials file
254
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
255
+ #
256
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
257
+ # The minimum size in bytes that triggers compression for request
258
+ # bodies. The value must be non-negative integer value between 0
259
+ # and 10485780 bytes inclusive.
260
+ #
261
+ # @option options [Proc] :retry_backoff
262
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
263
+ # This option is only used in the `legacy` retry mode.
264
+ #
265
+ # @option options [Float] :retry_base_delay (0.3)
266
+ # The base delay in seconds used by the default backoff function. This option
267
+ # is only used in the `legacy` retry mode.
268
+ #
269
+ # @option options [Symbol] :retry_jitter (:none)
270
+ # A delay randomiser function used by the default backoff function.
271
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
272
+ # otherwise a Proc that takes and returns a number. This option is only used
273
+ # in the `legacy` retry mode.
274
+ #
275
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
276
+ #
277
+ # @option options [Integer] :retry_limit (3)
278
+ # The maximum number of times to retry failed requests. Only
279
+ # ~ 500 level server errors and certain ~ 400 level client errors
280
+ # are retried. Generally, these are throttling errors, data
281
+ # checksum errors, networking errors, timeout errors, auth errors,
282
+ # endpoint discovery, and errors from expired credentials.
283
+ # This option is only used in the `legacy` retry mode.
284
+ #
285
+ # @option options [Integer] :retry_max_delay (0)
286
+ # The maximum number of seconds to delay between retries (0 for no limit)
287
+ # used by the default backoff function. This option is only used in the
288
+ # `legacy` retry mode.
289
+ #
290
+ # @option options [String] :retry_mode ("legacy")
291
+ # Specifies which retry algorithm to use. Values are:
292
+ #
293
+ # * `legacy` - The pre-existing retry behavior. This is default value if
294
+ # no retry mode is provided.
295
+ #
296
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
297
+ # This includes support for retry quotas, which limit the number of
298
+ # unsuccessful retries a client can make.
299
+ #
300
+ # * `adaptive` - An experimental retry mode that includes all the
301
+ # functionality of `standard` mode along with automatic client side
302
+ # throttling. This is a provisional mode that may change behavior
303
+ # in the future.
304
+ #
305
+ # @option options [String] :sdk_ua_app_id
306
+ # A unique and opaque application ID that is appended to the
307
+ # User-Agent header as app/sdk_ua_app_id. It should have a
308
+ # maximum length of 50. This variable is sourced from environment
309
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
310
+ #
311
+ # @option options [String] :secret_access_key
312
+ #
313
+ # @option options [String] :session_token
314
+ #
315
+ # @option options [Array] :sigv4a_signing_region_set
316
+ # A list of regions that should be signed with SigV4a signing. When
317
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
318
+ # in the following locations:
319
+ #
320
+ # * `Aws.config[:sigv4a_signing_region_set]`
321
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
322
+ # * `~/.aws/config`
323
+ #
324
+ # @option options [Boolean] :simple_json (false)
325
+ # Disables request parameter conversion, validation, and formatting.
326
+ # Also disables response data type conversions. The request parameters
327
+ # hash must be formatted exactly as the API expects.This option is useful
328
+ # when you want to ensure the highest level of performance by avoiding
329
+ # overhead of walking request parameters and response data structures.
330
+ #
331
+ # @option options [Boolean] :stub_responses (false)
332
+ # Causes the client to return stubbed responses. By default
333
+ # fake responses are generated and returned. You can specify
334
+ # the response data to return or errors to raise by calling
335
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
336
+ #
337
+ # ** Please note ** When response stubbing is enabled, no HTTP
338
+ # requests are made, and retries are disabled.
339
+ #
340
+ # @option options [Aws::TokenProvider] :token_provider
341
+ # A Bearer Token Provider. This can be an instance of any one of the
342
+ # following classes:
343
+ #
344
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
345
+ # tokens.
346
+ #
347
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
348
+ # access token generated from `aws login`.
349
+ #
350
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
351
+ # will be used to search for tokens configured for your profile in shared configuration files.
352
+ #
353
+ # @option options [Boolean] :use_dualstack_endpoint
354
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
355
+ # will be used if available.
356
+ #
357
+ # @option options [Boolean] :use_fips_endpoint
358
+ # When set to `true`, fips compatible endpoints will be used if available.
359
+ # When a `fips` region is used, the region is normalized and this config
360
+ # is set to `true`.
361
+ #
362
+ # @option options [Boolean] :validate_params (true)
363
+ # When `true`, request parameters are validated before
364
+ # sending the request.
365
+ #
366
+ # @option options [Aws::PCS::EndpointProvider] :endpoint_provider
367
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PCS::EndpointParameters`
368
+ #
369
+ # @option options [Float] :http_continue_timeout (1)
370
+ # The number of seconds to wait for a 100-continue response before sending the
371
+ # request body. This option has no effect unless the request has "Expect"
372
+ # header set to "100-continue". Defaults to `nil` which disables this
373
+ # behaviour. This value can safely be set per request on the session.
374
+ #
375
+ # @option options [Float] :http_idle_timeout (5)
376
+ # The number of seconds a connection is allowed to sit idle before it
377
+ # is considered stale. Stale connections are closed and removed from the
378
+ # pool before making a request.
379
+ #
380
+ # @option options [Float] :http_open_timeout (15)
381
+ # The default number of seconds to wait for response data.
382
+ # This value can safely be set per-request on the session.
383
+ #
384
+ # @option options [URI::HTTP,String] :http_proxy
385
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
386
+ #
387
+ # @option options [Float] :http_read_timeout (60)
388
+ # The default number of seconds to wait for response data.
389
+ # This value can safely be set per-request on the session.
390
+ #
391
+ # @option options [Boolean] :http_wire_trace (false)
392
+ # When `true`, HTTP debug output will be sent to the `:logger`.
393
+ #
394
+ # @option options [Proc] :on_chunk_received
395
+ # When a Proc object is provided, it will be used as callback when each chunk
396
+ # of the response body is received. It provides three arguments: the chunk,
397
+ # the number of bytes received, and the total number of
398
+ # bytes in the response (or nil if the server did not send a `content-length`).
399
+ #
400
+ # @option options [Proc] :on_chunk_sent
401
+ # When a Proc object is provided, it will be used as callback when each chunk
402
+ # of the request body is sent. It provides three arguments: the chunk,
403
+ # the number of bytes read from the body, and the total number of
404
+ # bytes in the body.
405
+ #
406
+ # @option options [Boolean] :raise_response_errors (true)
407
+ # When `true`, response errors are raised.
408
+ #
409
+ # @option options [String] :ssl_ca_bundle
410
+ # Full path to the SSL certificate authority bundle file that should be used when
411
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
412
+ # `:ssl_ca_directory` the the system default will be used if available.
413
+ #
414
+ # @option options [String] :ssl_ca_directory
415
+ # Full path of the directory that contains the unbundled SSL certificate
416
+ # authority files for verifying peer certificates. If you do
417
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
418
+ # default will be used if available.
419
+ #
420
+ # @option options [String] :ssl_ca_store
421
+ # Sets the X509::Store to verify peer certificate.
422
+ #
423
+ # @option options [Float] :ssl_timeout
424
+ # Sets the SSL timeout in seconds
425
+ #
426
+ # @option options [Boolean] :ssl_verify_peer (true)
427
+ # When `true`, SSL peer certificates are verified when establishing a connection.
428
+ #
429
+ def initialize(*args)
430
+ super
431
+ end
432
+
433
+ # @!group API Operations
434
+
435
+ # Creates a cluster in your account. Amazon Web Services PCS creates the
436
+ # cluster controller in a service-owned account. The cluster controller
437
+ # communicates with the cluster resources in your account. The subnets
438
+ # and security groups for the cluster must already exist before you use
439
+ # this API action.
440
+ #
441
+ # <note markdown="1"> It takes time for Amazon Web Services PCS to create the cluster. The
442
+ # cluster is in a `Creating` state until it is ready to use. There can
443
+ # only be 1 cluster in a `Creating` state per Amazon Web Services Region
444
+ # per Amazon Web Services account. `CreateCluster` fails with a
445
+ # `ServiceQuotaExceededException` if there is already a cluster in a
446
+ # `Creating` state.
447
+ #
448
+ # </note>
449
+ #
450
+ # @option params [required, String] :cluster_name
451
+ # A name to identify the cluster. Example: `MyCluster`
452
+ #
453
+ # @option params [required, Types::SchedulerRequest] :scheduler
454
+ # The cluster management and job scheduling software associated with the
455
+ # cluster.
456
+ #
457
+ # @option params [required, String] :size
458
+ # A value that determines the maximum number of compute nodes in the
459
+ # cluster and the maximum number of jobs (active and queued).
460
+ #
461
+ # * `SMALL`: 32 compute nodes and 256 jobs
462
+ #
463
+ # * `MEDIUM`: 512 compute nodes and 8192 jobs
464
+ #
465
+ # * `LARGE`: 2048 compute nodes and 16,384 jobs
466
+ #
467
+ # @option params [required, Types::NetworkingRequest] :networking
468
+ # The networking configuration used to set up the cluster's control
469
+ # plane.
470
+ #
471
+ # @option params [Types::ClusterSlurmConfigurationRequest] :slurm_configuration
472
+ # Additional options related to the Slurm scheduler.
473
+ #
474
+ # @option params [String] :client_token
475
+ # A unique, case-sensitive identifier that you provide to ensure the
476
+ # idempotency of the request. Idempotency ensures that an API request
477
+ # completes only once. With an idempotent request, if the original
478
+ # request completes successfully, the subsequent retries with the same
479
+ # client token return the result from the original successful request
480
+ # and they have no additional effect. If you don't specify a client
481
+ # token, the CLI and SDK automatically generate 1 for you.
482
+ #
483
+ # **A suitable default value is auto-generated.** You should normally
484
+ # not need to pass this option.**
485
+ #
486
+ # @option params [Hash<String,String>] :tags
487
+ # 1 or more tags added to the resource. Each tag consists of a tag key
488
+ # and tag value. The tag value is optional and can be an empty string.
489
+ #
490
+ # @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
491
+ #
492
+ # * {Types::CreateClusterResponse#cluster #cluster} => Types::Cluster
493
+ #
494
+ # @example Request syntax with placeholder values
495
+ #
496
+ # resp = client.create_cluster({
497
+ # cluster_name: "ClusterName", # required
498
+ # scheduler: { # required
499
+ # type: "SLURM", # required, accepts SLURM
500
+ # version: "String", # required
501
+ # },
502
+ # size: "SMALL", # required, accepts SMALL, MEDIUM, LARGE
503
+ # networking: { # required
504
+ # subnet_ids: ["SubnetId"],
505
+ # security_group_ids: ["SecurityGroupId"],
506
+ # },
507
+ # slurm_configuration: {
508
+ # scale_down_idle_time_in_seconds: 1,
509
+ # slurm_custom_settings: [
510
+ # {
511
+ # parameter_name: "String", # required
512
+ # parameter_value: "String", # required
513
+ # },
514
+ # ],
515
+ # },
516
+ # client_token: "SBClientToken",
517
+ # tags: {
518
+ # "TagKey" => "TagValue",
519
+ # },
520
+ # })
521
+ #
522
+ # @example Response structure
523
+ #
524
+ # resp.cluster.name #=> String
525
+ # resp.cluster.id #=> String
526
+ # resp.cluster.arn #=> String
527
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
528
+ # resp.cluster.created_at #=> Time
529
+ # resp.cluster.modified_at #=> Time
530
+ # resp.cluster.scheduler.type #=> String, one of "SLURM"
531
+ # resp.cluster.scheduler.version #=> String
532
+ # resp.cluster.size #=> String, one of "SMALL", "MEDIUM", "LARGE"
533
+ # resp.cluster.slurm_configuration.scale_down_idle_time_in_seconds #=> Integer
534
+ # resp.cluster.slurm_configuration.slurm_custom_settings #=> Array
535
+ # resp.cluster.slurm_configuration.slurm_custom_settings[0].parameter_name #=> String
536
+ # resp.cluster.slurm_configuration.slurm_custom_settings[0].parameter_value #=> String
537
+ # resp.cluster.slurm_configuration.auth_key.secret_arn #=> String
538
+ # resp.cluster.slurm_configuration.auth_key.secret_version #=> String
539
+ # resp.cluster.networking.subnet_ids #=> Array
540
+ # resp.cluster.networking.subnet_ids[0] #=> String
541
+ # resp.cluster.networking.security_group_ids #=> Array
542
+ # resp.cluster.networking.security_group_ids[0] #=> String
543
+ # resp.cluster.endpoints #=> Array
544
+ # resp.cluster.endpoints[0].type #=> String, one of "SLURMCTLD", "SLURMDBD"
545
+ # resp.cluster.endpoints[0].private_ip_address #=> String
546
+ # resp.cluster.endpoints[0].public_ip_address #=> String
547
+ # resp.cluster.endpoints[0].port #=> String
548
+ # resp.cluster.error_info #=> Array
549
+ # resp.cluster.error_info[0].code #=> String
550
+ # resp.cluster.error_info[0].message #=> String
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/CreateCluster AWS API Documentation
553
+ #
554
+ # @overload create_cluster(params = {})
555
+ # @param [Hash] params ({})
556
+ def create_cluster(params = {}, options = {})
557
+ req = build_request(:create_cluster, params)
558
+ req.send_request(options)
559
+ end
560
+
561
+ # Creates a managed set of compute nodes. You associate a compute node
562
+ # group with a cluster through 1 or more Amazon Web Services PCS queues
563
+ # or as part of the login fleet. A compute node group includes the
564
+ # definition of the compute properties and lifecycle management. Amazon
565
+ # Web Services PCS uses the information you provide to this API action
566
+ # to launch compute nodes in your account. You can only specify subnets
567
+ # in the same Amazon VPC as your cluster. You receive billing charges
568
+ # for the compute nodes that Amazon Web Services PCS launches in your
569
+ # account. You must already have a launch template before you call this
570
+ # API. For more information, see [Launch an instance from a launch
571
+ # template][1] in the *Amazon Elastic Compute Cloud User Guide for Linux
572
+ # Instances*.
573
+ #
574
+ #
575
+ #
576
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
577
+ #
578
+ # @option params [required, String] :cluster_identifier
579
+ # The name or ID of the cluster to create a compute node group in.
580
+ #
581
+ # @option params [required, String] :compute_node_group_name
582
+ # A name to identify the cluster. Example: `MyCluster`
583
+ #
584
+ # @option params [String] :ami_id
585
+ # The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS
586
+ # uses to launch compute nodes (Amazon EC2 instances). If you don't
587
+ # provide this value, Amazon Web Services PCS uses the AMI ID specified
588
+ # in the custom launch template.
589
+ #
590
+ # @option params [required, Array<String>] :subnet_ids
591
+ # The list of subnet IDs where the compute node group launches
592
+ # instances. Subnets must be in the same VPC as the cluster.
593
+ #
594
+ # @option params [String] :purchase_option
595
+ # Specifies how EC2 instances are purchased on your behalf. Amazon Web
596
+ # Services PCS supports On-Demand and Spot instances. For more
597
+ # information, see [Instance purchasing options][1] in the *Amazon
598
+ # Elastic Compute Cloud User Guide*. If you don't provide this option,
599
+ # it defaults to On-Demand.
600
+ #
601
+ #
602
+ #
603
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html
604
+ #
605
+ # @option params [required, Types::CustomLaunchTemplate] :custom_launch_template
606
+ # An Amazon EC2 launch template Amazon Web Services PCS uses to launch
607
+ # compute nodes.
608
+ #
609
+ # @option params [required, String] :iam_instance_profile_arn
610
+ # The Amazon Resource Name (ARN) of the IAM instance profile used to
611
+ # pass an IAM role when launching EC2 instances. The role contained in
612
+ # your instance profile must have `pcs:RegisterComputeNodeGroupInstance`
613
+ # permissions attached in order to provision instances correctly. The
614
+ # resource identifier of the ARN must start with `AWSPCS`. For example,
615
+ # `arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile`.
616
+ #
617
+ # @option params [required, Types::ScalingConfigurationRequest] :scaling_configuration
618
+ # Specifies the boundaries of the compute node group auto scaling.
619
+ #
620
+ # @option params [required, Array<Types::InstanceConfig>] :instance_configs
621
+ # A list of EC2 instance configurations that Amazon Web Services PCS can
622
+ # provision in the compute node group.
623
+ #
624
+ # @option params [Types::SpotOptions] :spot_options
625
+ # Additional configuration when you specify `SPOT` as the
626
+ # `purchaseOption` for the `CreateComputeNodeGroup` API action.
627
+ #
628
+ # @option params [Types::ComputeNodeGroupSlurmConfigurationRequest] :slurm_configuration
629
+ # Additional options related to the Slurm scheduler.
630
+ #
631
+ # @option params [String] :client_token
632
+ # A unique, case-sensitive identifier that you provide to ensure the
633
+ # idempotency of the request. Idempotency ensures that an API request
634
+ # completes only once. With an idempotent request, if the original
635
+ # request completes successfully, the subsequent retries with the same
636
+ # client token return the result from the original successful request
637
+ # and they have no additional effect. If you don't specify a client
638
+ # token, the CLI and SDK automatically generate 1 for you.
639
+ #
640
+ # **A suitable default value is auto-generated.** You should normally
641
+ # not need to pass this option.**
642
+ #
643
+ # @option params [Hash<String,String>] :tags
644
+ # 1 or more tags added to the resource. Each tag consists of a tag key
645
+ # and tag value. The tag value is optional and can be an empty string.
646
+ #
647
+ # @return [Types::CreateComputeNodeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
648
+ #
649
+ # * {Types::CreateComputeNodeGroupResponse#compute_node_group #compute_node_group} => Types::ComputeNodeGroup
650
+ #
651
+ # @example Request syntax with placeholder values
652
+ #
653
+ # resp = client.create_compute_node_group({
654
+ # cluster_identifier: "ClusterIdentifier", # required
655
+ # compute_node_group_name: "ComputeNodeGroupName", # required
656
+ # ami_id: "AmiId",
657
+ # subnet_ids: ["String"], # required
658
+ # purchase_option: "ONDEMAND", # accepts ONDEMAND, SPOT
659
+ # custom_launch_template: { # required
660
+ # id: "String", # required
661
+ # version: "String", # required
662
+ # },
663
+ # iam_instance_profile_arn: "InstanceProfileArn", # required
664
+ # scaling_configuration: { # required
665
+ # min_instance_count: 1, # required
666
+ # max_instance_count: 1, # required
667
+ # },
668
+ # instance_configs: [ # required
669
+ # {
670
+ # instance_type: "String",
671
+ # },
672
+ # ],
673
+ # spot_options: {
674
+ # allocation_strategy: "lowest-price", # accepts lowest-price, capacity-optimized, price-capacity-optimized
675
+ # },
676
+ # slurm_configuration: {
677
+ # slurm_custom_settings: [
678
+ # {
679
+ # parameter_name: "String", # required
680
+ # parameter_value: "String", # required
681
+ # },
682
+ # ],
683
+ # },
684
+ # client_token: "SBClientToken",
685
+ # tags: {
686
+ # "TagKey" => "TagValue",
687
+ # },
688
+ # })
689
+ #
690
+ # @example Response structure
691
+ #
692
+ # resp.compute_node_group.name #=> String
693
+ # resp.compute_node_group.id #=> String
694
+ # resp.compute_node_group.arn #=> String
695
+ # resp.compute_node_group.cluster_id #=> String
696
+ # resp.compute_node_group.created_at #=> Time
697
+ # resp.compute_node_group.modified_at #=> Time
698
+ # resp.compute_node_group.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED", "DELETED"
699
+ # resp.compute_node_group.ami_id #=> String
700
+ # resp.compute_node_group.subnet_ids #=> Array
701
+ # resp.compute_node_group.subnet_ids[0] #=> String
702
+ # resp.compute_node_group.purchase_option #=> String, one of "ONDEMAND", "SPOT"
703
+ # resp.compute_node_group.custom_launch_template.id #=> String
704
+ # resp.compute_node_group.custom_launch_template.version #=> String
705
+ # resp.compute_node_group.iam_instance_profile_arn #=> String
706
+ # resp.compute_node_group.scaling_configuration.min_instance_count #=> Integer
707
+ # resp.compute_node_group.scaling_configuration.max_instance_count #=> Integer
708
+ # resp.compute_node_group.instance_configs #=> Array
709
+ # resp.compute_node_group.instance_configs[0].instance_type #=> String
710
+ # resp.compute_node_group.spot_options.allocation_strategy #=> String, one of "lowest-price", "capacity-optimized", "price-capacity-optimized"
711
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings #=> Array
712
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings[0].parameter_name #=> String
713
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings[0].parameter_value #=> String
714
+ # resp.compute_node_group.error_info #=> Array
715
+ # resp.compute_node_group.error_info[0].code #=> String
716
+ # resp.compute_node_group.error_info[0].message #=> String
717
+ #
718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/CreateComputeNodeGroup AWS API Documentation
719
+ #
720
+ # @overload create_compute_node_group(params = {})
721
+ # @param [Hash] params ({})
722
+ def create_compute_node_group(params = {}, options = {})
723
+ req = build_request(:create_compute_node_group, params)
724
+ req.send_request(options)
725
+ end
726
+
727
+ # Creates a job queue. You must associate 1 or more compute node groups
728
+ # with the queue. You can associate 1 compute node group with multiple
729
+ # queues.
730
+ #
731
+ # @option params [required, String] :cluster_identifier
732
+ # The name or ID of the cluster for which to create a queue.
733
+ #
734
+ # @option params [required, String] :queue_name
735
+ # A name to identify the queue.
736
+ #
737
+ # @option params [Array<Types::ComputeNodeGroupConfiguration>] :compute_node_group_configurations
738
+ # The list of compute node group configurations to associate with the
739
+ # queue. Queues assign jobs to associated compute node groups.
740
+ #
741
+ # @option params [String] :client_token
742
+ # A unique, case-sensitive identifier that you provide to ensure the
743
+ # idempotency of the request. Idempotency ensures that an API request
744
+ # completes only once. With an idempotent request, if the original
745
+ # request completes successfully, the subsequent retries with the same
746
+ # client token return the result from the original successful request
747
+ # and they have no additional effect. If you don't specify a client
748
+ # token, the CLI and SDK automatically generate 1 for you.
749
+ #
750
+ # **A suitable default value is auto-generated.** You should normally
751
+ # not need to pass this option.**
752
+ #
753
+ # @option params [Hash<String,String>] :tags
754
+ # 1 or more tags added to the resource. Each tag consists of a tag key
755
+ # and tag value. The tag value is optional and can be an empty string.
756
+ #
757
+ # @return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
758
+ #
759
+ # * {Types::CreateQueueResponse#queue #queue} => Types::Queue
760
+ #
761
+ # @example Request syntax with placeholder values
762
+ #
763
+ # resp = client.create_queue({
764
+ # cluster_identifier: "ClusterIdentifier", # required
765
+ # queue_name: "QueueName", # required
766
+ # compute_node_group_configurations: [
767
+ # {
768
+ # compute_node_group_id: "String",
769
+ # },
770
+ # ],
771
+ # client_token: "SBClientToken",
772
+ # tags: {
773
+ # "TagKey" => "TagValue",
774
+ # },
775
+ # })
776
+ #
777
+ # @example Response structure
778
+ #
779
+ # resp.queue.name #=> String
780
+ # resp.queue.id #=> String
781
+ # resp.queue.arn #=> String
782
+ # resp.queue.cluster_id #=> String
783
+ # resp.queue.created_at #=> Time
784
+ # resp.queue.modified_at #=> Time
785
+ # resp.queue.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
786
+ # resp.queue.compute_node_group_configurations #=> Array
787
+ # resp.queue.compute_node_group_configurations[0].compute_node_group_id #=> String
788
+ # resp.queue.error_info #=> Array
789
+ # resp.queue.error_info[0].code #=> String
790
+ # resp.queue.error_info[0].message #=> String
791
+ #
792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/CreateQueue AWS API Documentation
793
+ #
794
+ # @overload create_queue(params = {})
795
+ # @param [Hash] params ({})
796
+ def create_queue(params = {}, options = {})
797
+ req = build_request(:create_queue, params)
798
+ req.send_request(options)
799
+ end
800
+
801
+ # Deletes a cluster and all its linked resources. You must delete all
802
+ # queues and compute node groups associated with the cluster before you
803
+ # can delete the cluster.
804
+ #
805
+ # @option params [required, String] :cluster_identifier
806
+ # The name or ID of the cluster to delete.
807
+ #
808
+ # @option params [String] :client_token
809
+ # A unique, case-sensitive identifier that you provide to ensure the
810
+ # idempotency of the request. Idempotency ensures that an API request
811
+ # completes only once. With an idempotent request, if the original
812
+ # request completes successfully, the subsequent retries with the same
813
+ # client token return the result from the original successful request
814
+ # and they have no additional effect. If you don't specify a client
815
+ # token, the CLI and SDK automatically generate 1 for you.
816
+ #
817
+ # **A suitable default value is auto-generated.** You should normally
818
+ # not need to pass this option.**
819
+ #
820
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
821
+ #
822
+ # @example Request syntax with placeholder values
823
+ #
824
+ # resp = client.delete_cluster({
825
+ # cluster_identifier: "ClusterIdentifier", # required
826
+ # client_token: "SBClientToken",
827
+ # })
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/DeleteCluster AWS API Documentation
830
+ #
831
+ # @overload delete_cluster(params = {})
832
+ # @param [Hash] params ({})
833
+ def delete_cluster(params = {}, options = {})
834
+ req = build_request(:delete_cluster, params)
835
+ req.send_request(options)
836
+ end
837
+
838
+ # Deletes a compute node group. You must delete all queues associated
839
+ # with the compute node group first.
840
+ #
841
+ # @option params [required, String] :cluster_identifier
842
+ # The name or ID of the cluster of the compute node group.
843
+ #
844
+ # @option params [required, String] :compute_node_group_identifier
845
+ # The name or ID of the compute node group to delete.
846
+ #
847
+ # @option params [String] :client_token
848
+ # A unique, case-sensitive identifier that you provide to ensure the
849
+ # idempotency of the request. Idempotency ensures that an API request
850
+ # completes only once. With an idempotent request, if the original
851
+ # request completes successfully, the subsequent retries with the same
852
+ # client token return the result from the original successful request
853
+ # and they have no additional effect. If you don't specify a client
854
+ # token, the CLI and SDK automatically generate 1 for you.
855
+ #
856
+ # **A suitable default value is auto-generated.** You should normally
857
+ # not need to pass this option.**
858
+ #
859
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
860
+ #
861
+ # @example Request syntax with placeholder values
862
+ #
863
+ # resp = client.delete_compute_node_group({
864
+ # cluster_identifier: "ClusterIdentifier", # required
865
+ # compute_node_group_identifier: "ComputeNodeGroupIdentifier", # required
866
+ # client_token: "SBClientToken",
867
+ # })
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/DeleteComputeNodeGroup AWS API Documentation
870
+ #
871
+ # @overload delete_compute_node_group(params = {})
872
+ # @param [Hash] params ({})
873
+ def delete_compute_node_group(params = {}, options = {})
874
+ req = build_request(:delete_compute_node_group, params)
875
+ req.send_request(options)
876
+ end
877
+
878
+ # Deletes a job queue. If the compute node group associated with this
879
+ # queue isn't associated with any other queues, Amazon Web Services PCS
880
+ # terminates all the compute nodes for this queue.
881
+ #
882
+ # @option params [required, String] :cluster_identifier
883
+ # The name or ID of the cluster of the queue.
884
+ #
885
+ # @option params [required, String] :queue_identifier
886
+ # The name or ID of the queue to delete.
887
+ #
888
+ # @option params [String] :client_token
889
+ # A unique, case-sensitive identifier that you provide to ensure the
890
+ # idempotency of the request. Idempotency ensures that an API request
891
+ # completes only once. With an idempotent request, if the original
892
+ # request completes successfully, the subsequent retries with the same
893
+ # client token return the result from the original successful request
894
+ # and they have no additional effect. If you don't specify a client
895
+ # token, the CLI and SDK automatically generate 1 for you.
896
+ #
897
+ # **A suitable default value is auto-generated.** You should normally
898
+ # not need to pass this option.**
899
+ #
900
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
901
+ #
902
+ # @example Request syntax with placeholder values
903
+ #
904
+ # resp = client.delete_queue({
905
+ # cluster_identifier: "ClusterIdentifier", # required
906
+ # queue_identifier: "QueueIdentifier", # required
907
+ # client_token: "SBClientToken",
908
+ # })
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/DeleteQueue AWS API Documentation
911
+ #
912
+ # @overload delete_queue(params = {})
913
+ # @param [Hash] params ({})
914
+ def delete_queue(params = {}, options = {})
915
+ req = build_request(:delete_queue, params)
916
+ req.send_request(options)
917
+ end
918
+
919
+ # Returns detailed information about a running cluster in your account.
920
+ # This API action provides networking information, endpoint information
921
+ # for communication with the scheduler, and provisioning status.
922
+ #
923
+ # @option params [required, String] :cluster_identifier
924
+ # The name or ID of the cluster of the queue.
925
+ #
926
+ # @return [Types::GetClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
927
+ #
928
+ # * {Types::GetClusterResponse#cluster #cluster} => Types::Cluster
929
+ #
930
+ # @example Request syntax with placeholder values
931
+ #
932
+ # resp = client.get_cluster({
933
+ # cluster_identifier: "ClusterIdentifier", # required
934
+ # })
935
+ #
936
+ # @example Response structure
937
+ #
938
+ # resp.cluster.name #=> String
939
+ # resp.cluster.id #=> String
940
+ # resp.cluster.arn #=> String
941
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
942
+ # resp.cluster.created_at #=> Time
943
+ # resp.cluster.modified_at #=> Time
944
+ # resp.cluster.scheduler.type #=> String, one of "SLURM"
945
+ # resp.cluster.scheduler.version #=> String
946
+ # resp.cluster.size #=> String, one of "SMALL", "MEDIUM", "LARGE"
947
+ # resp.cluster.slurm_configuration.scale_down_idle_time_in_seconds #=> Integer
948
+ # resp.cluster.slurm_configuration.slurm_custom_settings #=> Array
949
+ # resp.cluster.slurm_configuration.slurm_custom_settings[0].parameter_name #=> String
950
+ # resp.cluster.slurm_configuration.slurm_custom_settings[0].parameter_value #=> String
951
+ # resp.cluster.slurm_configuration.auth_key.secret_arn #=> String
952
+ # resp.cluster.slurm_configuration.auth_key.secret_version #=> String
953
+ # resp.cluster.networking.subnet_ids #=> Array
954
+ # resp.cluster.networking.subnet_ids[0] #=> String
955
+ # resp.cluster.networking.security_group_ids #=> Array
956
+ # resp.cluster.networking.security_group_ids[0] #=> String
957
+ # resp.cluster.endpoints #=> Array
958
+ # resp.cluster.endpoints[0].type #=> String, one of "SLURMCTLD", "SLURMDBD"
959
+ # resp.cluster.endpoints[0].private_ip_address #=> String
960
+ # resp.cluster.endpoints[0].public_ip_address #=> String
961
+ # resp.cluster.endpoints[0].port #=> String
962
+ # resp.cluster.error_info #=> Array
963
+ # resp.cluster.error_info[0].code #=> String
964
+ # resp.cluster.error_info[0].message #=> String
965
+ #
966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/GetCluster AWS API Documentation
967
+ #
968
+ # @overload get_cluster(params = {})
969
+ # @param [Hash] params ({})
970
+ def get_cluster(params = {}, options = {})
971
+ req = build_request(:get_cluster, params)
972
+ req.send_request(options)
973
+ end
974
+
975
+ # Returns detailed information about a compute node group. This API
976
+ # action provides networking information, EC2 instance type, compute
977
+ # node group status, and scheduler (such as Slurm) configuration.
978
+ #
979
+ # @option params [required, String] :cluster_identifier
980
+ # The name or ID of the cluster.
981
+ #
982
+ # @option params [required, String] :compute_node_group_identifier
983
+ # The name or ID of the compute node group.
984
+ #
985
+ # @return [Types::GetComputeNodeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
986
+ #
987
+ # * {Types::GetComputeNodeGroupResponse#compute_node_group #compute_node_group} => Types::ComputeNodeGroup
988
+ #
989
+ # @example Request syntax with placeholder values
990
+ #
991
+ # resp = client.get_compute_node_group({
992
+ # cluster_identifier: "ClusterIdentifier", # required
993
+ # compute_node_group_identifier: "ComputeNodeGroupIdentifier", # required
994
+ # })
995
+ #
996
+ # @example Response structure
997
+ #
998
+ # resp.compute_node_group.name #=> String
999
+ # resp.compute_node_group.id #=> String
1000
+ # resp.compute_node_group.arn #=> String
1001
+ # resp.compute_node_group.cluster_id #=> String
1002
+ # resp.compute_node_group.created_at #=> Time
1003
+ # resp.compute_node_group.modified_at #=> Time
1004
+ # resp.compute_node_group.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED", "DELETED"
1005
+ # resp.compute_node_group.ami_id #=> String
1006
+ # resp.compute_node_group.subnet_ids #=> Array
1007
+ # resp.compute_node_group.subnet_ids[0] #=> String
1008
+ # resp.compute_node_group.purchase_option #=> String, one of "ONDEMAND", "SPOT"
1009
+ # resp.compute_node_group.custom_launch_template.id #=> String
1010
+ # resp.compute_node_group.custom_launch_template.version #=> String
1011
+ # resp.compute_node_group.iam_instance_profile_arn #=> String
1012
+ # resp.compute_node_group.scaling_configuration.min_instance_count #=> Integer
1013
+ # resp.compute_node_group.scaling_configuration.max_instance_count #=> Integer
1014
+ # resp.compute_node_group.instance_configs #=> Array
1015
+ # resp.compute_node_group.instance_configs[0].instance_type #=> String
1016
+ # resp.compute_node_group.spot_options.allocation_strategy #=> String, one of "lowest-price", "capacity-optimized", "price-capacity-optimized"
1017
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings #=> Array
1018
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings[0].parameter_name #=> String
1019
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings[0].parameter_value #=> String
1020
+ # resp.compute_node_group.error_info #=> Array
1021
+ # resp.compute_node_group.error_info[0].code #=> String
1022
+ # resp.compute_node_group.error_info[0].message #=> String
1023
+ #
1024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/GetComputeNodeGroup AWS API Documentation
1025
+ #
1026
+ # @overload get_compute_node_group(params = {})
1027
+ # @param [Hash] params ({})
1028
+ def get_compute_node_group(params = {}, options = {})
1029
+ req = build_request(:get_compute_node_group, params)
1030
+ req.send_request(options)
1031
+ end
1032
+
1033
+ # Returns detailed information about a queue. The information includes
1034
+ # the compute node groups that the queue uses to schedule jobs.
1035
+ #
1036
+ # @option params [required, String] :cluster_identifier
1037
+ # The name or ID of the cluster of the queue.
1038
+ #
1039
+ # @option params [required, String] :queue_identifier
1040
+ # The name or ID of the queue.
1041
+ #
1042
+ # @return [Types::GetQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1043
+ #
1044
+ # * {Types::GetQueueResponse#queue #queue} => Types::Queue
1045
+ #
1046
+ # @example Request syntax with placeholder values
1047
+ #
1048
+ # resp = client.get_queue({
1049
+ # cluster_identifier: "ClusterIdentifier", # required
1050
+ # queue_identifier: "QueueIdentifier", # required
1051
+ # })
1052
+ #
1053
+ # @example Response structure
1054
+ #
1055
+ # resp.queue.name #=> String
1056
+ # resp.queue.id #=> String
1057
+ # resp.queue.arn #=> String
1058
+ # resp.queue.cluster_id #=> String
1059
+ # resp.queue.created_at #=> Time
1060
+ # resp.queue.modified_at #=> Time
1061
+ # resp.queue.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
1062
+ # resp.queue.compute_node_group_configurations #=> Array
1063
+ # resp.queue.compute_node_group_configurations[0].compute_node_group_id #=> String
1064
+ # resp.queue.error_info #=> Array
1065
+ # resp.queue.error_info[0].code #=> String
1066
+ # resp.queue.error_info[0].message #=> String
1067
+ #
1068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/GetQueue AWS API Documentation
1069
+ #
1070
+ # @overload get_queue(params = {})
1071
+ # @param [Hash] params ({})
1072
+ def get_queue(params = {}, options = {})
1073
+ req = build_request(:get_queue, params)
1074
+ req.send_request(options)
1075
+ end
1076
+
1077
+ # Returns a list of running clusters in your account.
1078
+ #
1079
+ # @option params [String] :next_token
1080
+ # The value of `nextToken` is a unique pagination token for each page of
1081
+ # results returned. If `nextToken` is returned, there are more results
1082
+ # available. Make the call again using the returned token to retrieve
1083
+ # the next page. Keep all other arguments unchanged. Each pagination
1084
+ # token expires after 24 hours. Using an expired pagination token
1085
+ # returns an `HTTP 400 InvalidToken` error.
1086
+ #
1087
+ # @option params [Integer] :max_results
1088
+ # The maximum number of results that are returned per call. You can use
1089
+ # `nextToken` to obtain further pages of results. The default is 10
1090
+ # results, and the maximum allowed page size is 100 results. A value of
1091
+ # 0 uses the default.
1092
+ #
1093
+ # @return [Types::ListClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1094
+ #
1095
+ # * {Types::ListClustersResponse#clusters #clusters} => Array&lt;Types::ClusterSummary&gt;
1096
+ # * {Types::ListClustersResponse#next_token #next_token} => String
1097
+ #
1098
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1099
+ #
1100
+ # @example Request syntax with placeholder values
1101
+ #
1102
+ # resp = client.list_clusters({
1103
+ # next_token: "String",
1104
+ # max_results: 1,
1105
+ # })
1106
+ #
1107
+ # @example Response structure
1108
+ #
1109
+ # resp.clusters #=> Array
1110
+ # resp.clusters[0].name #=> String
1111
+ # resp.clusters[0].id #=> String
1112
+ # resp.clusters[0].arn #=> String
1113
+ # resp.clusters[0].created_at #=> Time
1114
+ # resp.clusters[0].modified_at #=> Time
1115
+ # resp.clusters[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
1116
+ # resp.next_token #=> String
1117
+ #
1118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/ListClusters AWS API Documentation
1119
+ #
1120
+ # @overload list_clusters(params = {})
1121
+ # @param [Hash] params ({})
1122
+ def list_clusters(params = {}, options = {})
1123
+ req = build_request(:list_clusters, params)
1124
+ req.send_request(options)
1125
+ end
1126
+
1127
+ # Returns a list of all compute node groups associated with a cluster.
1128
+ #
1129
+ # @option params [required, String] :cluster_identifier
1130
+ # The name or ID of the cluster to list compute node groups for.
1131
+ #
1132
+ # @option params [String] :next_token
1133
+ # The value of `nextToken` is a unique pagination token for each page of
1134
+ # results returned. If `nextToken` is returned, there are more results
1135
+ # available. Make the call again using the returned token to retrieve
1136
+ # the next page. Keep all other arguments unchanged. Each pagination
1137
+ # token expires after 24 hours. Using an expired pagination token
1138
+ # returns an `HTTP 400 InvalidToken` error.
1139
+ #
1140
+ # @option params [Integer] :max_results
1141
+ # The maximum number of results that are returned per call. You can use
1142
+ # `nextToken` to obtain further pages of results. The default is 10
1143
+ # results, and the maximum allowed page size is 100 results. A value of
1144
+ # 0 uses the default.
1145
+ #
1146
+ # @return [Types::ListComputeNodeGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1147
+ #
1148
+ # * {Types::ListComputeNodeGroupsResponse#compute_node_groups #compute_node_groups} => Array&lt;Types::ComputeNodeGroupSummary&gt;
1149
+ # * {Types::ListComputeNodeGroupsResponse#next_token #next_token} => String
1150
+ #
1151
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1152
+ #
1153
+ # @example Request syntax with placeholder values
1154
+ #
1155
+ # resp = client.list_compute_node_groups({
1156
+ # cluster_identifier: "ClusterIdentifier", # required
1157
+ # next_token: "String",
1158
+ # max_results: 1,
1159
+ # })
1160
+ #
1161
+ # @example Response structure
1162
+ #
1163
+ # resp.compute_node_groups #=> Array
1164
+ # resp.compute_node_groups[0].name #=> String
1165
+ # resp.compute_node_groups[0].id #=> String
1166
+ # resp.compute_node_groups[0].arn #=> String
1167
+ # resp.compute_node_groups[0].cluster_id #=> String
1168
+ # resp.compute_node_groups[0].created_at #=> Time
1169
+ # resp.compute_node_groups[0].modified_at #=> Time
1170
+ # resp.compute_node_groups[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED", "DELETED"
1171
+ # resp.next_token #=> String
1172
+ #
1173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/ListComputeNodeGroups AWS API Documentation
1174
+ #
1175
+ # @overload list_compute_node_groups(params = {})
1176
+ # @param [Hash] params ({})
1177
+ def list_compute_node_groups(params = {}, options = {})
1178
+ req = build_request(:list_compute_node_groups, params)
1179
+ req.send_request(options)
1180
+ end
1181
+
1182
+ # Returns a list of all queues associated with a cluster.
1183
+ #
1184
+ # @option params [required, String] :cluster_identifier
1185
+ # The name or ID of the cluster to list queues for.
1186
+ #
1187
+ # @option params [String] :next_token
1188
+ # The value of `nextToken` is a unique pagination token for each page of
1189
+ # results returned. If `nextToken` is returned, there are more results
1190
+ # available. Make the call again using the returned token to retrieve
1191
+ # the next page. Keep all other arguments unchanged. Each pagination
1192
+ # token expires after 24 hours. Using an expired pagination token
1193
+ # returns an `HTTP 400 InvalidToken` error.
1194
+ #
1195
+ # @option params [Integer] :max_results
1196
+ # The maximum number of results that are returned per call. You can use
1197
+ # `nextToken` to obtain further pages of results. The default is 10
1198
+ # results, and the maximum allowed page size is 100 results. A value of
1199
+ # 0 uses the default.
1200
+ #
1201
+ # @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1202
+ #
1203
+ # * {Types::ListQueuesResponse#queues #queues} => Array&lt;Types::QueueSummary&gt;
1204
+ # * {Types::ListQueuesResponse#next_token #next_token} => String
1205
+ #
1206
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1207
+ #
1208
+ # @example Request syntax with placeholder values
1209
+ #
1210
+ # resp = client.list_queues({
1211
+ # cluster_identifier: "ClusterIdentifier", # required
1212
+ # next_token: "String",
1213
+ # max_results: 1,
1214
+ # })
1215
+ #
1216
+ # @example Response structure
1217
+ #
1218
+ # resp.queues #=> Array
1219
+ # resp.queues[0].name #=> String
1220
+ # resp.queues[0].id #=> String
1221
+ # resp.queues[0].arn #=> String
1222
+ # resp.queues[0].cluster_id #=> String
1223
+ # resp.queues[0].created_at #=> Time
1224
+ # resp.queues[0].modified_at #=> Time
1225
+ # resp.queues[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
1226
+ # resp.next_token #=> String
1227
+ #
1228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/ListQueues AWS API Documentation
1229
+ #
1230
+ # @overload list_queues(params = {})
1231
+ # @param [Hash] params ({})
1232
+ def list_queues(params = {}, options = {})
1233
+ req = build_request(:list_queues, params)
1234
+ req.send_request(options)
1235
+ end
1236
+
1237
+ # Returns a list of all tags on an Amazon Web Services PCS resource.
1238
+ #
1239
+ # @option params [required, String] :resource_arn
1240
+ # The Amazon Resource Name (ARN) of the resource for which to list tags.
1241
+ #
1242
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1243
+ #
1244
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1245
+ #
1246
+ # @example Request syntax with placeholder values
1247
+ #
1248
+ # resp = client.list_tags_for_resource({
1249
+ # resource_arn: "Arn", # required
1250
+ # })
1251
+ #
1252
+ # @example Response structure
1253
+ #
1254
+ # resp.tags #=> Hash
1255
+ # resp.tags["TagKey"] #=> String
1256
+ #
1257
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/ListTagsForResource AWS API Documentation
1258
+ #
1259
+ # @overload list_tags_for_resource(params = {})
1260
+ # @param [Hash] params ({})
1261
+ def list_tags_for_resource(params = {}, options = {})
1262
+ req = build_request(:list_tags_for_resource, params)
1263
+ req.send_request(options)
1264
+ end
1265
+
1266
+ # This API action isn't intended for you to use.
1267
+ #
1268
+ # Amazon Web Services PCS uses this API action to register the compute
1269
+ # nodes it launches in your account.
1270
+ #
1271
+ # @option params [required, String] :cluster_identifier
1272
+ # The name or ID of the cluster to register the compute node group
1273
+ # instance in.
1274
+ #
1275
+ # @option params [required, String] :bootstrap_id
1276
+ # The client-generated token to allow for retries.
1277
+ #
1278
+ # @return [Types::RegisterComputeNodeGroupInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1279
+ #
1280
+ # * {Types::RegisterComputeNodeGroupInstanceResponse#node_id #node_id} => String
1281
+ # * {Types::RegisterComputeNodeGroupInstanceResponse#shared_secret #shared_secret} => String
1282
+ # * {Types::RegisterComputeNodeGroupInstanceResponse#endpoints #endpoints} => Array&lt;Types::Endpoint&gt;
1283
+ #
1284
+ # @example Request syntax with placeholder values
1285
+ #
1286
+ # resp = client.register_compute_node_group_instance({
1287
+ # cluster_identifier: "ClusterIdentifier", # required
1288
+ # bootstrap_id: "BootstrapId", # required
1289
+ # })
1290
+ #
1291
+ # @example Response structure
1292
+ #
1293
+ # resp.node_id #=> String
1294
+ # resp.shared_secret #=> String
1295
+ # resp.endpoints #=> Array
1296
+ # resp.endpoints[0].type #=> String, one of "SLURMCTLD", "SLURMDBD"
1297
+ # resp.endpoints[0].private_ip_address #=> String
1298
+ # resp.endpoints[0].public_ip_address #=> String
1299
+ # resp.endpoints[0].port #=> String
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/RegisterComputeNodeGroupInstance AWS API Documentation
1302
+ #
1303
+ # @overload register_compute_node_group_instance(params = {})
1304
+ # @param [Hash] params ({})
1305
+ def register_compute_node_group_instance(params = {}, options = {})
1306
+ req = build_request(:register_compute_node_group_instance, params)
1307
+ req.send_request(options)
1308
+ end
1309
+
1310
+ # Adds or edits tags on an Amazon Web Services PCS resource. Each tag
1311
+ # consists of a tag key and a tag value. The tag key and tag value are
1312
+ # case-sensitive strings. The tag value can be an empty (null) string.
1313
+ # To add a tag, specify a new tag key and a tag value. To edit a tag,
1314
+ # specify an existing tag key and a new tag value.
1315
+ #
1316
+ # @option params [required, String] :resource_arn
1317
+ # The Amazon Resource Name (ARN) of the resource.
1318
+ #
1319
+ # @option params [required, Hash<String,String>] :tags
1320
+ # 1 or more tags added to the resource. Each tag consists of a tag key
1321
+ # and tag value. The tag value is optional and can be an empty string.
1322
+ #
1323
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1324
+ #
1325
+ # @example Request syntax with placeholder values
1326
+ #
1327
+ # resp = client.tag_resource({
1328
+ # resource_arn: "Arn", # required
1329
+ # tags: { # required
1330
+ # "TagKey" => "TagValue",
1331
+ # },
1332
+ # })
1333
+ #
1334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/TagResource AWS API Documentation
1335
+ #
1336
+ # @overload tag_resource(params = {})
1337
+ # @param [Hash] params ({})
1338
+ def tag_resource(params = {}, options = {})
1339
+ req = build_request(:tag_resource, params)
1340
+ req.send_request(options)
1341
+ end
1342
+
1343
+ # Deletes tags from an Amazon Web Services PCS resource. To delete a
1344
+ # tag, specify the tag key and the Amazon Resource Name (ARN) of the
1345
+ # Amazon Web Services PCS resource.
1346
+ #
1347
+ # @option params [required, String] :resource_arn
1348
+ # The Amazon Resource Name (ARN) of the resource.
1349
+ #
1350
+ # @option params [required, Array<String>] :tag_keys
1351
+ # 1 or more tag keys to remove from the resource. Specify only tag keys
1352
+ # and not tag values.
1353
+ #
1354
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1355
+ #
1356
+ # @example Request syntax with placeholder values
1357
+ #
1358
+ # resp = client.untag_resource({
1359
+ # resource_arn: "Arn", # required
1360
+ # tag_keys: ["TagKey"], # required
1361
+ # })
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/UntagResource AWS API Documentation
1364
+ #
1365
+ # @overload untag_resource(params = {})
1366
+ # @param [Hash] params ({})
1367
+ def untag_resource(params = {}, options = {})
1368
+ req = build_request(:untag_resource, params)
1369
+ req.send_request(options)
1370
+ end
1371
+
1372
+ # Updates a compute node group. You can update many of the fields
1373
+ # related to your compute node group including the configurations for
1374
+ # networking, compute nodes, and settings specific to your scheduler
1375
+ # (such as Slurm).
1376
+ #
1377
+ # @option params [required, String] :cluster_identifier
1378
+ # The name or ID of the cluster of the compute node group.
1379
+ #
1380
+ # @option params [required, String] :compute_node_group_identifier
1381
+ # The name or ID of the compute node group.
1382
+ #
1383
+ # @option params [String] :ami_id
1384
+ # The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS
1385
+ # uses to launch instances. If not provided, Amazon Web Services PCS
1386
+ # uses the AMI ID specified in the custom launch template.
1387
+ #
1388
+ # @option params [Array<String>] :subnet_ids
1389
+ # The list of subnet IDs where the compute node group provisions
1390
+ # instances. The subnets must be in the same VPC as the cluster.
1391
+ #
1392
+ # @option params [Types::CustomLaunchTemplate] :custom_launch_template
1393
+ # An Amazon EC2 launch template Amazon Web Services PCS uses to launch
1394
+ # compute nodes.
1395
+ #
1396
+ # @option params [String] :purchase_option
1397
+ # Specifies how EC2 instances are purchased on your behalf. Amazon Web
1398
+ # Services PCS supports On-Demand and Spot instances. For more
1399
+ # information, see [Instance purchasing options][1] in the *Amazon
1400
+ # Elastic Compute Cloud User Guide*. If you don't provide this option,
1401
+ # it defaults to On-Demand.
1402
+ #
1403
+ #
1404
+ #
1405
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html
1406
+ #
1407
+ # @option params [Types::SpotOptions] :spot_options
1408
+ # Additional configuration when you specify `SPOT` as the
1409
+ # `purchaseOption` for the `CreateComputeNodeGroup` API action.
1410
+ #
1411
+ # @option params [Types::ScalingConfigurationRequest] :scaling_configuration
1412
+ # Specifies the boundaries of the compute node group auto scaling.
1413
+ #
1414
+ # @option params [String] :iam_instance_profile_arn
1415
+ # The Amazon Resource Name (ARN) of the IAM instance profile used to
1416
+ # pass an IAM role when launching EC2 instances. The role contained in
1417
+ # your instance profile must have `pcs:RegisterComputeNodeGroupInstance`
1418
+ # permissions attached to provision instances correctly.
1419
+ #
1420
+ # @option params [Types::UpdateComputeNodeGroupSlurmConfigurationRequest] :slurm_configuration
1421
+ # Additional options related to the Slurm scheduler.
1422
+ #
1423
+ # @option params [String] :client_token
1424
+ # A unique, case-sensitive identifier that you provide to ensure the
1425
+ # idempotency of the request. Idempotency ensures that an API request
1426
+ # completes only once. With an idempotent request, if the original
1427
+ # request completes successfully, the subsequent retries with the same
1428
+ # client token return the result from the original successful request
1429
+ # and they have no additional effect. If you don't specify a client
1430
+ # token, the CLI and SDK automatically generate 1 for you.
1431
+ #
1432
+ # **A suitable default value is auto-generated.** You should normally
1433
+ # not need to pass this option.**
1434
+ #
1435
+ # @return [Types::UpdateComputeNodeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1436
+ #
1437
+ # * {Types::UpdateComputeNodeGroupResponse#compute_node_group #compute_node_group} => Types::ComputeNodeGroup
1438
+ #
1439
+ # @example Request syntax with placeholder values
1440
+ #
1441
+ # resp = client.update_compute_node_group({
1442
+ # cluster_identifier: "ClusterIdentifier", # required
1443
+ # compute_node_group_identifier: "ComputeNodeGroupIdentifier", # required
1444
+ # ami_id: "AmiId",
1445
+ # subnet_ids: ["String"],
1446
+ # custom_launch_template: {
1447
+ # id: "String", # required
1448
+ # version: "String", # required
1449
+ # },
1450
+ # purchase_option: "ONDEMAND", # accepts ONDEMAND, SPOT
1451
+ # spot_options: {
1452
+ # allocation_strategy: "lowest-price", # accepts lowest-price, capacity-optimized, price-capacity-optimized
1453
+ # },
1454
+ # scaling_configuration: {
1455
+ # min_instance_count: 1, # required
1456
+ # max_instance_count: 1, # required
1457
+ # },
1458
+ # iam_instance_profile_arn: "InstanceProfileArn",
1459
+ # slurm_configuration: {
1460
+ # slurm_custom_settings: [
1461
+ # {
1462
+ # parameter_name: "String", # required
1463
+ # parameter_value: "String", # required
1464
+ # },
1465
+ # ],
1466
+ # },
1467
+ # client_token: "SBClientToken",
1468
+ # })
1469
+ #
1470
+ # @example Response structure
1471
+ #
1472
+ # resp.compute_node_group.name #=> String
1473
+ # resp.compute_node_group.id #=> String
1474
+ # resp.compute_node_group.arn #=> String
1475
+ # resp.compute_node_group.cluster_id #=> String
1476
+ # resp.compute_node_group.created_at #=> Time
1477
+ # resp.compute_node_group.modified_at #=> Time
1478
+ # resp.compute_node_group.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED", "DELETED"
1479
+ # resp.compute_node_group.ami_id #=> String
1480
+ # resp.compute_node_group.subnet_ids #=> Array
1481
+ # resp.compute_node_group.subnet_ids[0] #=> String
1482
+ # resp.compute_node_group.purchase_option #=> String, one of "ONDEMAND", "SPOT"
1483
+ # resp.compute_node_group.custom_launch_template.id #=> String
1484
+ # resp.compute_node_group.custom_launch_template.version #=> String
1485
+ # resp.compute_node_group.iam_instance_profile_arn #=> String
1486
+ # resp.compute_node_group.scaling_configuration.min_instance_count #=> Integer
1487
+ # resp.compute_node_group.scaling_configuration.max_instance_count #=> Integer
1488
+ # resp.compute_node_group.instance_configs #=> Array
1489
+ # resp.compute_node_group.instance_configs[0].instance_type #=> String
1490
+ # resp.compute_node_group.spot_options.allocation_strategy #=> String, one of "lowest-price", "capacity-optimized", "price-capacity-optimized"
1491
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings #=> Array
1492
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings[0].parameter_name #=> String
1493
+ # resp.compute_node_group.slurm_configuration.slurm_custom_settings[0].parameter_value #=> String
1494
+ # resp.compute_node_group.error_info #=> Array
1495
+ # resp.compute_node_group.error_info[0].code #=> String
1496
+ # resp.compute_node_group.error_info[0].message #=> String
1497
+ #
1498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/UpdateComputeNodeGroup AWS API Documentation
1499
+ #
1500
+ # @overload update_compute_node_group(params = {})
1501
+ # @param [Hash] params ({})
1502
+ def update_compute_node_group(params = {}, options = {})
1503
+ req = build_request(:update_compute_node_group, params)
1504
+ req.send_request(options)
1505
+ end
1506
+
1507
+ # Updates the compute node group configuration of a queue. Use this API
1508
+ # to change the compute node groups that the queue can send jobs to.
1509
+ #
1510
+ # @option params [required, String] :cluster_identifier
1511
+ # The name or ID of the cluster of the queue.
1512
+ #
1513
+ # @option params [required, String] :queue_identifier
1514
+ # The name or ID of the queue.
1515
+ #
1516
+ # @option params [Array<Types::ComputeNodeGroupConfiguration>] :compute_node_group_configurations
1517
+ # The list of compute node group configurations to associate with the
1518
+ # queue. Queues assign jobs to associated compute node groups.
1519
+ #
1520
+ # @option params [String] :client_token
1521
+ # A unique, case-sensitive identifier that you provide to ensure the
1522
+ # idempotency of the request. Idempotency ensures that an API request
1523
+ # completes only once. With an idempotent request, if the original
1524
+ # request completes successfully, the subsequent retries with the same
1525
+ # client token return the result from the original successful request
1526
+ # and they have no additional effect. If you don't specify a client
1527
+ # token, the CLI and SDK automatically generate 1 for you.
1528
+ #
1529
+ # **A suitable default value is auto-generated.** You should normally
1530
+ # not need to pass this option.**
1531
+ #
1532
+ # @return [Types::UpdateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1533
+ #
1534
+ # * {Types::UpdateQueueResponse#queue #queue} => Types::Queue
1535
+ #
1536
+ # @example Request syntax with placeholder values
1537
+ #
1538
+ # resp = client.update_queue({
1539
+ # cluster_identifier: "ClusterIdentifier", # required
1540
+ # queue_identifier: "QueueIdentifier", # required
1541
+ # compute_node_group_configurations: [
1542
+ # {
1543
+ # compute_node_group_id: "String",
1544
+ # },
1545
+ # ],
1546
+ # client_token: "SBClientToken",
1547
+ # })
1548
+ #
1549
+ # @example Response structure
1550
+ #
1551
+ # resp.queue.name #=> String
1552
+ # resp.queue.id #=> String
1553
+ # resp.queue.arn #=> String
1554
+ # resp.queue.cluster_id #=> String
1555
+ # resp.queue.created_at #=> Time
1556
+ # resp.queue.modified_at #=> Time
1557
+ # resp.queue.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED", "UPDATE_FAILED"
1558
+ # resp.queue.compute_node_group_configurations #=> Array
1559
+ # resp.queue.compute_node_group_configurations[0].compute_node_group_id #=> String
1560
+ # resp.queue.error_info #=> Array
1561
+ # resp.queue.error_info[0].code #=> String
1562
+ # resp.queue.error_info[0].message #=> String
1563
+ #
1564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/UpdateQueue AWS API Documentation
1565
+ #
1566
+ # @overload update_queue(params = {})
1567
+ # @param [Hash] params ({})
1568
+ def update_queue(params = {}, options = {})
1569
+ req = build_request(:update_queue, params)
1570
+ req.send_request(options)
1571
+ end
1572
+
1573
+ # @!endgroup
1574
+
1575
+ # @param params ({})
1576
+ # @api private
1577
+ def build_request(operation_name, params = {})
1578
+ handlers = @handlers.for(operation_name)
1579
+ context = Seahorse::Client::RequestContext.new(
1580
+ operation_name: operation_name,
1581
+ operation: config.api.operation(operation_name),
1582
+ client: self,
1583
+ params: params,
1584
+ config: config)
1585
+ context[:gem_name] = 'aws-sdk-pcs'
1586
+ context[:gem_version] = '1.0.0'
1587
+ Seahorse::Client::Request.new(handlers, context)
1588
+ end
1589
+
1590
+ # @api private
1591
+ # @deprecated
1592
+ def waiter_names
1593
+ []
1594
+ end
1595
+
1596
+ class << self
1597
+
1598
+ # @api private
1599
+ attr_reader :identifier
1600
+
1601
+ # @api private
1602
+ def errors_module
1603
+ Errors
1604
+ end
1605
+
1606
+ end
1607
+ end
1608
+ end