aws-sdk-gamesparks 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1792 @@
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/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/signature_v4.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:gamesparks)
37
+
38
+ module Aws::GameSparks
39
+ # An API client for GameSparks. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::GameSparks::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :gamesparks
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::SignatureV4)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+
85
+ # @overload initialize(options)
86
+ # @param [Hash] options
87
+ # @option options [required, Aws::CredentialProvider] :credentials
88
+ # Your AWS credentials. This can be an instance of any one of the
89
+ # following classes:
90
+ #
91
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
92
+ # credentials.
93
+ #
94
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
95
+ # shared file, such as `~/.aws/config`.
96
+ #
97
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
98
+ #
99
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
100
+ # assume a role after providing credentials via the web.
101
+ #
102
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
103
+ # access token generated from `aws login`.
104
+ #
105
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
106
+ # process that outputs to stdout.
107
+ #
108
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
109
+ # from an EC2 IMDS on an EC2 instance.
110
+ #
111
+ # * `Aws::ECSCredentials` - Used for loading credentials from
112
+ # instances running in ECS.
113
+ #
114
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
115
+ # from the Cognito Identity service.
116
+ #
117
+ # When `:credentials` are not configured directly, the following
118
+ # locations will be searched for credentials:
119
+ #
120
+ # * `Aws.config[:credentials]`
121
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
122
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
123
+ # * `~/.aws/credentials`
124
+ # * `~/.aws/config`
125
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
126
+ # are very aggressive. Construct and pass an instance of
127
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
128
+ # enable retries and extended timeouts. Instance profile credential
129
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
130
+ # to true.
131
+ #
132
+ # @option options [required, String] :region
133
+ # The AWS region to connect to. The configured `:region` is
134
+ # used to determine the service `:endpoint`. When not passed,
135
+ # a default `:region` is searched for in the following locations:
136
+ #
137
+ # * `Aws.config[:region]`
138
+ # * `ENV['AWS_REGION']`
139
+ # * `ENV['AMAZON_REGION']`
140
+ # * `ENV['AWS_DEFAULT_REGION']`
141
+ # * `~/.aws/credentials`
142
+ # * `~/.aws/config`
143
+ #
144
+ # @option options [String] :access_key_id
145
+ #
146
+ # @option options [Boolean] :active_endpoint_cache (false)
147
+ # When set to `true`, a thread polling for endpoints will be running in
148
+ # the background every 60 secs (default). Defaults to `false`.
149
+ #
150
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
151
+ # Used only in `adaptive` retry mode. When true, the request will sleep
152
+ # until there is sufficent client side capacity to retry the request.
153
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
154
+ # not retry instead of sleeping.
155
+ #
156
+ # @option options [Boolean] :client_side_monitoring (false)
157
+ # When `true`, client-side metrics will be collected for all API requests from
158
+ # this client.
159
+ #
160
+ # @option options [String] :client_side_monitoring_client_id ("")
161
+ # Allows you to provide an identifier for this client which will be attached to
162
+ # all generated client side metrics. Defaults to an empty string.
163
+ #
164
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
165
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
166
+ # side monitoring agent is running on, where client metrics will be published via UDP.
167
+ #
168
+ # @option options [Integer] :client_side_monitoring_port (31000)
169
+ # Required for publishing client metrics. The port that the client side monitoring
170
+ # agent is running on, where client metrics will be published via UDP.
171
+ #
172
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
173
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
174
+ # will use the Client Side Monitoring Agent Publisher.
175
+ #
176
+ # @option options [Boolean] :convert_params (true)
177
+ # When `true`, an attempt is made to coerce request parameters into
178
+ # the required types.
179
+ #
180
+ # @option options [Boolean] :correct_clock_skew (true)
181
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
182
+ # a clock skew correction and retry requests with skewed client clocks.
183
+ #
184
+ # @option options [String] :defaults_mode ("legacy")
185
+ # See {Aws::DefaultsModeConfiguration} for a list of the
186
+ # accepted modes and the configuration defaults that are included.
187
+ #
188
+ # @option options [Boolean] :disable_host_prefix_injection (false)
189
+ # Set to true to disable SDK automatically adding host prefix
190
+ # to default service endpoint when available.
191
+ #
192
+ # @option options [String] :endpoint
193
+ # The client endpoint is normally constructed from the `:region`
194
+ # option. You should only configure an `:endpoint` when connecting
195
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
196
+ #
197
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
198
+ # Used for the maximum size limit of the LRU cache storing endpoints data
199
+ # for endpoint discovery enabled operations. Defaults to 1000.
200
+ #
201
+ # @option options [Integer] :endpoint_cache_max_threads (10)
202
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
205
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
206
+ # Use this option to config the time interval in seconds for making
207
+ # requests fetching endpoints information. Defaults to 60 sec.
208
+ #
209
+ # @option options [Boolean] :endpoint_discovery (false)
210
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
211
+ #
212
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
213
+ # The log formatter.
214
+ #
215
+ # @option options [Symbol] :log_level (:info)
216
+ # The log level to send messages to the `:logger` at.
217
+ #
218
+ # @option options [Logger] :logger
219
+ # The Logger instance to send log messages to. If this option
220
+ # is not set, logging will be disabled.
221
+ #
222
+ # @option options [Integer] :max_attempts (3)
223
+ # An integer representing the maximum number attempts that will be made for
224
+ # a single request, including the initial attempt. For example,
225
+ # setting this value to 5 will result in a request being retried up to
226
+ # 4 times. Used in `standard` and `adaptive` retry modes.
227
+ #
228
+ # @option options [String] :profile ("default")
229
+ # Used when loading credentials from the shared credentials file
230
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
231
+ #
232
+ # @option options [Proc] :retry_backoff
233
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
234
+ # This option is only used in the `legacy` retry mode.
235
+ #
236
+ # @option options [Float] :retry_base_delay (0.3)
237
+ # The base delay in seconds used by the default backoff function. This option
238
+ # is only used in the `legacy` retry mode.
239
+ #
240
+ # @option options [Symbol] :retry_jitter (:none)
241
+ # A delay randomiser function used by the default backoff function.
242
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
243
+ # otherwise a Proc that takes and returns a number. This option is only used
244
+ # in the `legacy` retry mode.
245
+ #
246
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
247
+ #
248
+ # @option options [Integer] :retry_limit (3)
249
+ # The maximum number of times to retry failed requests. Only
250
+ # ~ 500 level server errors and certain ~ 400 level client errors
251
+ # are retried. Generally, these are throttling errors, data
252
+ # checksum errors, networking errors, timeout errors, auth errors,
253
+ # endpoint discovery, and errors from expired credentials.
254
+ # This option is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Integer] :retry_max_delay (0)
257
+ # The maximum number of seconds to delay between retries (0 for no limit)
258
+ # used by the default backoff function. This option is only used in the
259
+ # `legacy` retry mode.
260
+ #
261
+ # @option options [String] :retry_mode ("legacy")
262
+ # Specifies which retry algorithm to use. Values are:
263
+ #
264
+ # * `legacy` - The pre-existing retry behavior. This is default value if
265
+ # no retry mode is provided.
266
+ #
267
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
268
+ # This includes support for retry quotas, which limit the number of
269
+ # unsuccessful retries a client can make.
270
+ #
271
+ # * `adaptive` - An experimental retry mode that includes all the
272
+ # functionality of `standard` mode along with automatic client side
273
+ # throttling. This is a provisional mode that may change behavior
274
+ # in the future.
275
+ #
276
+ #
277
+ # @option options [String] :secret_access_key
278
+ #
279
+ # @option options [String] :session_token
280
+ #
281
+ # @option options [Boolean] :stub_responses (false)
282
+ # Causes the client to return stubbed responses. By default
283
+ # fake responses are generated and returned. You can specify
284
+ # the response data to return or errors to raise by calling
285
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
286
+ #
287
+ # ** Please note ** When response stubbing is enabled, no HTTP
288
+ # requests are made, and retries are disabled.
289
+ #
290
+ # @option options [Boolean] :use_dualstack_endpoint
291
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
+ # will be used if available.
293
+ #
294
+ # @option options [Boolean] :use_fips_endpoint
295
+ # When set to `true`, fips compatible endpoints will be used if available.
296
+ # When a `fips` region is used, the region is normalized and this config
297
+ # is set to `true`.
298
+ #
299
+ # @option options [Boolean] :validate_params (true)
300
+ # When `true`, request parameters are validated before
301
+ # sending the request.
302
+ #
303
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
304
+ # requests through. Formatted like 'http://proxy.com:123'.
305
+ #
306
+ # @option options [Float] :http_open_timeout (15) The number of
307
+ # seconds to wait when opening a HTTP session before raising a
308
+ # `Timeout::Error`.
309
+ #
310
+ # @option options [Float] :http_read_timeout (60) The default
311
+ # number of seconds to wait for response data. This value can
312
+ # safely be set per-request on the session.
313
+ #
314
+ # @option options [Float] :http_idle_timeout (5) The number of
315
+ # seconds a connection is allowed to sit idle before it is
316
+ # considered stale. Stale connections are closed and removed
317
+ # from the pool before making a request.
318
+ #
319
+ # @option options [Float] :http_continue_timeout (1) The number of
320
+ # seconds to wait for a 100-continue response before sending the
321
+ # request body. This option has no effect unless the request has
322
+ # "Expect" header set to "100-continue". Defaults to `nil` which
323
+ # disables this behaviour. This value can safely be set per
324
+ # request on the session.
325
+ #
326
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
327
+ # in seconds.
328
+ #
329
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
330
+ # HTTP debug output will be sent to the `:logger`.
331
+ #
332
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
333
+ # SSL peer certificates are verified when establishing a
334
+ # connection.
335
+ #
336
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
337
+ # certificate authority bundle file that should be used when
338
+ # verifying peer certificates. If you do not pass
339
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
340
+ # will be used if available.
341
+ #
342
+ # @option options [String] :ssl_ca_directory Full path of the
343
+ # directory that contains the unbundled SSL certificate
344
+ # authority files for verifying peer certificates. If you do
345
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
346
+ # system default will be used if available.
347
+ #
348
+ def initialize(*args)
349
+ super
350
+ end
351
+
352
+ # @!group API Operations
353
+
354
+ # Creates a new game with an empty configuration. After creating your
355
+ # game, you can update the configuration using `UpdateGameConfiguration`
356
+ # or `ImportGameConfiguration`.
357
+ #
358
+ # @option params [String] :client_token
359
+ # A client-defined token. With an active client token in the request,
360
+ # this action is idempotent.
361
+ #
362
+ # @option params [String] :description
363
+ # The description of the game.
364
+ #
365
+ # @option params [required, String] :game_name
366
+ # The name of the game.
367
+ #
368
+ # @option params [Hash<String,String>] :tags
369
+ # The list of tags to apply to the game.
370
+ #
371
+ # @return [Types::CreateGameResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
372
+ #
373
+ # * {Types::CreateGameResult#game #game} => Types::GameDetails
374
+ #
375
+ # @example Request syntax with placeholder values
376
+ #
377
+ # resp = client.create_game({
378
+ # client_token: "ClientToken",
379
+ # description: "GameDescription",
380
+ # game_name: "GameName", # required
381
+ # tags: {
382
+ # "TagKey" => "TagValue",
383
+ # },
384
+ # })
385
+ #
386
+ # @example Response structure
387
+ #
388
+ # resp.game.arn #=> String
389
+ # resp.game.created #=> Time
390
+ # resp.game.description #=> String
391
+ # resp.game.enable_termination_protection #=> Boolean
392
+ # resp.game.last_updated #=> Time
393
+ # resp.game.name #=> String
394
+ # resp.game.state #=> String, one of "ACTIVE", "DELETING"
395
+ # resp.game.tags #=> Hash
396
+ # resp.game.tags["TagKey"] #=> String
397
+ #
398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/CreateGame AWS API Documentation
399
+ #
400
+ # @overload create_game(params = {})
401
+ # @param [Hash] params ({})
402
+ def create_game(params = {}, options = {})
403
+ req = build_request(:create_game, params)
404
+ req.send_request(options)
405
+ end
406
+
407
+ # Creates a snapshot of the game configuration.
408
+ #
409
+ # @option params [String] :description
410
+ # The description of the snapshot.
411
+ #
412
+ # @option params [required, String] :game_name
413
+ # The name of the game.
414
+ #
415
+ # @return [Types::CreateSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
416
+ #
417
+ # * {Types::CreateSnapshotResult#snapshot #snapshot} => Types::SnapshotDetails
418
+ #
419
+ # @example Request syntax with placeholder values
420
+ #
421
+ # resp = client.create_snapshot({
422
+ # description: "SnapshotDescription",
423
+ # game_name: "GameName", # required
424
+ # })
425
+ #
426
+ # @example Response structure
427
+ #
428
+ # resp.snapshot.created #=> Time
429
+ # resp.snapshot.description #=> String
430
+ # resp.snapshot.id #=> String
431
+ # resp.snapshot.last_updated #=> Time
432
+ # resp.snapshot.sections #=> Hash
433
+ # resp.snapshot.sections["SectionName"].name #=> String
434
+ # resp.snapshot.sections["SectionName"].size #=> Integer
435
+ #
436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/CreateSnapshot AWS API Documentation
437
+ #
438
+ # @overload create_snapshot(params = {})
439
+ # @param [Hash] params ({})
440
+ def create_snapshot(params = {}, options = {})
441
+ req = build_request(:create_snapshot, params)
442
+ req.send_request(options)
443
+ end
444
+
445
+ # Creates a new stage for stage-by-stage game development and
446
+ # deployment.
447
+ #
448
+ # @option params [String] :client_token
449
+ # A client-defined token. With an active client token in the request,
450
+ # this action is idempotent.
451
+ #
452
+ # @option params [String] :description
453
+ # The description of the stage.
454
+ #
455
+ # @option params [required, String] :game_name
456
+ # The name of the game.
457
+ #
458
+ # @option params [required, String] :role
459
+ # The Amazon Resource Name (ARN) of the role to run the game with. This
460
+ # role can be a game-defined role or the default role that GameSparks
461
+ # created.
462
+ #
463
+ # @option params [required, String] :stage_name
464
+ # The name of the stage.
465
+ #
466
+ # @option params [Hash<String,String>] :tags
467
+ # The list of tags to apply to the stage.
468
+ #
469
+ # @return [Types::CreateStageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
470
+ #
471
+ # * {Types::CreateStageResult#stage #stage} => Types::StageDetails
472
+ #
473
+ # @example Request syntax with placeholder values
474
+ #
475
+ # resp = client.create_stage({
476
+ # client_token: "ClientToken",
477
+ # description: "StageDescription",
478
+ # game_name: "GameName", # required
479
+ # role: "RoleARN", # required
480
+ # stage_name: "StageName", # required
481
+ # tags: {
482
+ # "TagKey" => "TagValue",
483
+ # },
484
+ # })
485
+ #
486
+ # @example Response structure
487
+ #
488
+ # resp.stage.arn #=> String
489
+ # resp.stage.created #=> Time
490
+ # resp.stage.description #=> String
491
+ # resp.stage.game_key #=> String
492
+ # resp.stage.last_updated #=> Time
493
+ # resp.stage.log_group #=> String
494
+ # resp.stage.name #=> String
495
+ # resp.stage.role #=> String
496
+ # resp.stage.state #=> String, one of "ACTIVE", "DELETING"
497
+ # resp.stage.tags #=> Hash
498
+ # resp.stage.tags["TagKey"] #=> String
499
+ #
500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/CreateStage AWS API Documentation
501
+ #
502
+ # @overload create_stage(params = {})
503
+ # @param [Hash] params ({})
504
+ def create_stage(params = {}, options = {})
505
+ req = build_request(:create_stage, params)
506
+ req.send_request(options)
507
+ end
508
+
509
+ # Deletes a game.
510
+ #
511
+ # @option params [required, String] :game_name
512
+ # The name of the game to delete.
513
+ #
514
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
515
+ #
516
+ # @example Request syntax with placeholder values
517
+ #
518
+ # resp = client.delete_game({
519
+ # game_name: "GameName", # required
520
+ # })
521
+ #
522
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/DeleteGame AWS API Documentation
523
+ #
524
+ # @overload delete_game(params = {})
525
+ # @param [Hash] params ({})
526
+ def delete_game(params = {}, options = {})
527
+ req = build_request(:delete_game, params)
528
+ req.send_request(options)
529
+ end
530
+
531
+ # Deletes a stage from a game, along with the associated game runtime.
532
+ #
533
+ # @option params [required, String] :game_name
534
+ # The name of the game.
535
+ #
536
+ # @option params [required, String] :stage_name
537
+ # The name of the stage to delete.
538
+ #
539
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
540
+ #
541
+ # @example Request syntax with placeholder values
542
+ #
543
+ # resp = client.delete_stage({
544
+ # game_name: "GameName", # required
545
+ # stage_name: "StageName", # required
546
+ # })
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/DeleteStage AWS API Documentation
549
+ #
550
+ # @overload delete_stage(params = {})
551
+ # @param [Hash] params ({})
552
+ def delete_stage(params = {}, options = {})
553
+ req = build_request(:delete_stage, params)
554
+ req.send_request(options)
555
+ end
556
+
557
+ # Disconnects a player from the game runtime.
558
+ #
559
+ # If a player has multiple connections, this operation attempts to close
560
+ # all of them.
561
+ #
562
+ # @option params [required, String] :game_name
563
+ # The name of the game.
564
+ #
565
+ # @option params [required, String] :player_id
566
+ # The unique identifier representing a player.
567
+ #
568
+ # @option params [required, String] :stage_name
569
+ # The name of the stage.
570
+ #
571
+ # @return [Types::DisconnectPlayerResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
572
+ #
573
+ # * {Types::DisconnectPlayerResult#disconnect_failures #disconnect_failures} => Array&lt;String&gt;
574
+ # * {Types::DisconnectPlayerResult#disconnect_successes #disconnect_successes} => Array&lt;String&gt;
575
+ #
576
+ # @example Request syntax with placeholder values
577
+ #
578
+ # resp = client.disconnect_player({
579
+ # game_name: "GameName", # required
580
+ # player_id: "PlayerId", # required
581
+ # stage_name: "StageName", # required
582
+ # })
583
+ #
584
+ # @example Response structure
585
+ #
586
+ # resp.disconnect_failures #=> Array
587
+ # resp.disconnect_failures[0] #=> String
588
+ # resp.disconnect_successes #=> Array
589
+ # resp.disconnect_successes[0] #=> String
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/DisconnectPlayer AWS API Documentation
592
+ #
593
+ # @overload disconnect_player(params = {})
594
+ # @param [Hash] params ({})
595
+ def disconnect_player(params = {}, options = {})
596
+ req = build_request(:disconnect_player, params)
597
+ req.send_request(options)
598
+ end
599
+
600
+ # Exports a game configuration snapshot.
601
+ #
602
+ # @option params [required, String] :game_name
603
+ # The name of the game.
604
+ #
605
+ # @option params [required, String] :snapshot_id
606
+ # The identifier of the snapshot to export.
607
+ #
608
+ # @return [Types::ExportSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
609
+ #
610
+ # * {Types::ExportSnapshotResult#s3_url #s3_url} => String
611
+ #
612
+ # @example Request syntax with placeholder values
613
+ #
614
+ # resp = client.export_snapshot({
615
+ # game_name: "GameName", # required
616
+ # snapshot_id: "SnapshotId", # required
617
+ # })
618
+ #
619
+ # @example Response structure
620
+ #
621
+ # resp.s3_url #=> String
622
+ #
623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ExportSnapshot AWS API Documentation
624
+ #
625
+ # @overload export_snapshot(params = {})
626
+ # @param [Hash] params ({})
627
+ def export_snapshot(params = {}, options = {})
628
+ req = build_request(:export_snapshot, params)
629
+ req.send_request(options)
630
+ end
631
+
632
+ # Gets details about a specified extension.
633
+ #
634
+ # @option params [required, String] :name
635
+ # The name of the extension.
636
+ #
637
+ # @option params [required, String] :namespace
638
+ # The namespace (qualifier) of the extension.
639
+ #
640
+ # @return [Types::GetExtensionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
641
+ #
642
+ # * {Types::GetExtensionResult#extension #extension} => Types::ExtensionDetails
643
+ #
644
+ # @example Request syntax with placeholder values
645
+ #
646
+ # resp = client.get_extension({
647
+ # name: "ExtensionName", # required
648
+ # namespace: "ExtensionNamespace", # required
649
+ # })
650
+ #
651
+ # @example Response structure
652
+ #
653
+ # resp.extension.description #=> String
654
+ # resp.extension.name #=> String
655
+ # resp.extension.namespace #=> String
656
+ #
657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetExtension AWS API Documentation
658
+ #
659
+ # @overload get_extension(params = {})
660
+ # @param [Hash] params ({})
661
+ def get_extension(params = {}, options = {})
662
+ req = build_request(:get_extension, params)
663
+ req.send_request(options)
664
+ end
665
+
666
+ # Gets details about a specified extension version.
667
+ #
668
+ # @option params [required, String] :extension_version
669
+ # The version of the extension.
670
+ #
671
+ # @option params [required, String] :name
672
+ # The name of the extension.
673
+ #
674
+ # @option params [required, String] :namespace
675
+ # The namespace (qualifier) of the extension.
676
+ #
677
+ # @return [Types::GetExtensionVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
678
+ #
679
+ # * {Types::GetExtensionVersionResult#extension_version #extension_version} => Types::ExtensionVersionDetails
680
+ #
681
+ # @example Request syntax with placeholder values
682
+ #
683
+ # resp = client.get_extension_version({
684
+ # extension_version: "ExtensionVersion", # required
685
+ # name: "ExtensionName", # required
686
+ # namespace: "ExtensionNamespace", # required
687
+ # })
688
+ #
689
+ # @example Response structure
690
+ #
691
+ # resp.extension_version.name #=> String
692
+ # resp.extension_version.namespace #=> String
693
+ # resp.extension_version.schema #=> String
694
+ # resp.extension_version.version #=> String
695
+ #
696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetExtensionVersion AWS API Documentation
697
+ #
698
+ # @overload get_extension_version(params = {})
699
+ # @param [Hash] params ({})
700
+ def get_extension_version(params = {}, options = {})
701
+ req = build_request(:get_extension_version, params)
702
+ req.send_request(options)
703
+ end
704
+
705
+ # Gets details about a game.
706
+ #
707
+ # @option params [required, String] :game_name
708
+ # The name of the game.
709
+ #
710
+ # @return [Types::GetGameResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
711
+ #
712
+ # * {Types::GetGameResult#game #game} => Types::GameDetails
713
+ #
714
+ # @example Request syntax with placeholder values
715
+ #
716
+ # resp = client.get_game({
717
+ # game_name: "GameName", # required
718
+ # })
719
+ #
720
+ # @example Response structure
721
+ #
722
+ # resp.game.arn #=> String
723
+ # resp.game.created #=> Time
724
+ # resp.game.description #=> String
725
+ # resp.game.enable_termination_protection #=> Boolean
726
+ # resp.game.last_updated #=> Time
727
+ # resp.game.name #=> String
728
+ # resp.game.state #=> String, one of "ACTIVE", "DELETING"
729
+ # resp.game.tags #=> Hash
730
+ # resp.game.tags["TagKey"] #=> String
731
+ #
732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetGame AWS API Documentation
733
+ #
734
+ # @overload get_game(params = {})
735
+ # @param [Hash] params ({})
736
+ def get_game(params = {}, options = {})
737
+ req = build_request(:get_game, params)
738
+ req.send_request(options)
739
+ end
740
+
741
+ # Gets the configuration of the game.
742
+ #
743
+ # @option params [required, String] :game_name
744
+ # The name of the game.
745
+ #
746
+ # @option params [Array<String>] :sections
747
+ # The list of sections to return.
748
+ #
749
+ # @return [Types::GetGameConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
750
+ #
751
+ # * {Types::GetGameConfigurationResult#game_configuration #game_configuration} => Types::GameConfigurationDetails
752
+ #
753
+ # @example Request syntax with placeholder values
754
+ #
755
+ # resp = client.get_game_configuration({
756
+ # game_name: "GameName", # required
757
+ # sections: ["SectionName"],
758
+ # })
759
+ #
760
+ # @example Response structure
761
+ #
762
+ # resp.game_configuration.created #=> Time
763
+ # resp.game_configuration.last_updated #=> Time
764
+ # resp.game_configuration.sections #=> Hash
765
+ # resp.game_configuration.sections["SectionName"].name #=> String
766
+ # resp.game_configuration.sections["SectionName"].size #=> Integer
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetGameConfiguration AWS API Documentation
769
+ #
770
+ # @overload get_game_configuration(params = {})
771
+ # @param [Hash] params ({})
772
+ def get_game_configuration(params = {}, options = {})
773
+ req = build_request(:get_game_configuration, params)
774
+ req.send_request(options)
775
+ end
776
+
777
+ # Gets details about a job that is generating code for a snapshot.
778
+ #
779
+ # @option params [required, String] :game_name
780
+ # The name of the game.
781
+ #
782
+ # @option params [required, String] :job_id
783
+ # The identifier of the code generation job.
784
+ #
785
+ # @option params [required, String] :snapshot_id
786
+ # The identifier of the snapshot for the code generation job.
787
+ #
788
+ # @return [Types::GetGeneratedCodeJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
789
+ #
790
+ # * {Types::GetGeneratedCodeJobResult#generated_code_job #generated_code_job} => Types::GeneratedCodeJobDetails
791
+ #
792
+ # @example Request syntax with placeholder values
793
+ #
794
+ # resp = client.get_generated_code_job({
795
+ # game_name: "GameName", # required
796
+ # job_id: "GeneratedCodeJobId", # required
797
+ # snapshot_id: "SnapshotId", # required
798
+ # })
799
+ #
800
+ # @example Response structure
801
+ #
802
+ # resp.generated_code_job.description #=> String
803
+ # resp.generated_code_job.expiration_time #=> Time
804
+ # resp.generated_code_job.generated_code_job_id #=> String
805
+ # resp.generated_code_job.s3_url #=> String
806
+ # resp.generated_code_job.status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "PENDING"
807
+ #
808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetGeneratedCodeJob AWS API Documentation
809
+ #
810
+ # @overload get_generated_code_job(params = {})
811
+ # @param [Hash] params ({})
812
+ def get_generated_code_job(params = {}, options = {})
813
+ req = build_request(:get_generated_code_job, params)
814
+ req.send_request(options)
815
+ end
816
+
817
+ # Gets the status of a player's connection to the game runtime.
818
+ #
819
+ # It's possible for a single player to have multiple connections to the
820
+ # game runtime. If a player is not connected, this operation returns an
821
+ # empty list.
822
+ #
823
+ # @option params [required, String] :game_name
824
+ # The name of the game.
825
+ #
826
+ # @option params [required, String] :player_id
827
+ # The unique identifier representing a player.
828
+ #
829
+ # @option params [required, String] :stage_name
830
+ # The name of the stage.
831
+ #
832
+ # @return [Types::GetPlayerConnectionStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
833
+ #
834
+ # * {Types::GetPlayerConnectionStatusResult#connections #connections} => Array&lt;Types::Connection&gt;
835
+ #
836
+ # @example Request syntax with placeholder values
837
+ #
838
+ # resp = client.get_player_connection_status({
839
+ # game_name: "GameName", # required
840
+ # player_id: "PlayerId", # required
841
+ # stage_name: "StageName", # required
842
+ # })
843
+ #
844
+ # @example Response structure
845
+ #
846
+ # resp.connections #=> Array
847
+ # resp.connections[0].created #=> Time
848
+ # resp.connections[0].id #=> String
849
+ #
850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetPlayerConnectionStatus AWS API Documentation
851
+ #
852
+ # @overload get_player_connection_status(params = {})
853
+ # @param [Hash] params ({})
854
+ def get_player_connection_status(params = {}, options = {})
855
+ req = build_request(:get_player_connection_status, params)
856
+ req.send_request(options)
857
+ end
858
+
859
+ # Gets a copy of the game configuration in a snapshot.
860
+ #
861
+ # @option params [required, String] :game_name
862
+ # The name of the game.
863
+ #
864
+ # @option params [Array<String>] :sections
865
+ # The list of game configuration sections to be described.
866
+ #
867
+ # @option params [required, String] :snapshot_id
868
+ # The identifier of the snapshot.
869
+ #
870
+ # @return [Types::GetSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
871
+ #
872
+ # * {Types::GetSnapshotResult#snapshot #snapshot} => Types::SnapshotDetails
873
+ #
874
+ # @example Request syntax with placeholder values
875
+ #
876
+ # resp = client.get_snapshot({
877
+ # game_name: "GameName", # required
878
+ # sections: ["SectionName"],
879
+ # snapshot_id: "SnapshotId", # required
880
+ # })
881
+ #
882
+ # @example Response structure
883
+ #
884
+ # resp.snapshot.created #=> Time
885
+ # resp.snapshot.description #=> String
886
+ # resp.snapshot.id #=> String
887
+ # resp.snapshot.last_updated #=> Time
888
+ # resp.snapshot.sections #=> Hash
889
+ # resp.snapshot.sections["SectionName"].name #=> String
890
+ # resp.snapshot.sections["SectionName"].size #=> Integer
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetSnapshot AWS API Documentation
893
+ #
894
+ # @overload get_snapshot(params = {})
895
+ # @param [Hash] params ({})
896
+ def get_snapshot(params = {}, options = {})
897
+ req = build_request(:get_snapshot, params)
898
+ req.send_request(options)
899
+ end
900
+
901
+ # Gets information about a stage.
902
+ #
903
+ # @option params [required, String] :game_name
904
+ # The name of the game.
905
+ #
906
+ # @option params [required, String] :stage_name
907
+ # The name of the stage.
908
+ #
909
+ # @return [Types::GetStageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
910
+ #
911
+ # * {Types::GetStageResult#stage #stage} => Types::StageDetails
912
+ #
913
+ # @example Request syntax with placeholder values
914
+ #
915
+ # resp = client.get_stage({
916
+ # game_name: "GameName", # required
917
+ # stage_name: "StageName", # required
918
+ # })
919
+ #
920
+ # @example Response structure
921
+ #
922
+ # resp.stage.arn #=> String
923
+ # resp.stage.created #=> Time
924
+ # resp.stage.description #=> String
925
+ # resp.stage.game_key #=> String
926
+ # resp.stage.last_updated #=> Time
927
+ # resp.stage.log_group #=> String
928
+ # resp.stage.name #=> String
929
+ # resp.stage.role #=> String
930
+ # resp.stage.state #=> String, one of "ACTIVE", "DELETING"
931
+ # resp.stage.tags #=> Hash
932
+ # resp.stage.tags["TagKey"] #=> String
933
+ #
934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetStage AWS API Documentation
935
+ #
936
+ # @overload get_stage(params = {})
937
+ # @param [Hash] params ({})
938
+ def get_stage(params = {}, options = {})
939
+ req = build_request(:get_stage, params)
940
+ req.send_request(options)
941
+ end
942
+
943
+ # Gets information about a stage deployment.
944
+ #
945
+ # @option params [String] :deployment_id
946
+ # The identifier of the stage deployment. `StartStageDeployment` returns
947
+ # the identifier that you use here.
948
+ #
949
+ # @option params [required, String] :game_name
950
+ # The name of the game.
951
+ #
952
+ # @option params [required, String] :stage_name
953
+ # The name of the stage.
954
+ #
955
+ # @return [Types::GetStageDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
956
+ #
957
+ # * {Types::GetStageDeploymentResult#stage_deployment #stage_deployment} => Types::StageDeploymentDetails
958
+ #
959
+ # @example Request syntax with placeholder values
960
+ #
961
+ # resp = client.get_stage_deployment({
962
+ # deployment_id: "DeploymentId",
963
+ # game_name: "GameName", # required
964
+ # stage_name: "StageName", # required
965
+ # })
966
+ #
967
+ # @example Response structure
968
+ #
969
+ # resp.stage_deployment.created #=> Time
970
+ # resp.stage_deployment.deployment_action #=> String, one of "DEPLOY", "UNDEPLOY"
971
+ # resp.stage_deployment.deployment_id #=> String
972
+ # resp.stage_deployment.deployment_state #=> String, one of "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"
973
+ # resp.stage_deployment.last_updated #=> Time
974
+ # resp.stage_deployment.snapshot_id #=> String
975
+ #
976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/GetStageDeployment AWS API Documentation
977
+ #
978
+ # @overload get_stage_deployment(params = {})
979
+ # @param [Hash] params ({})
980
+ def get_stage_deployment(params = {}, options = {})
981
+ req = build_request(:get_stage_deployment, params)
982
+ req.send_request(options)
983
+ end
984
+
985
+ # Imports a game configuration.
986
+ #
987
+ # This operation replaces the current configuration of the game with the
988
+ # provided input. This is not a reversible operation. If you want to
989
+ # preserve the previous configuration, use `CreateSnapshot` to make a
990
+ # new snapshot before importing.
991
+ #
992
+ # @option params [required, String] :game_name
993
+ # The name of the game.
994
+ #
995
+ # @option params [required, Types::ImportGameConfigurationSource] :import_source
996
+ # The source used to import configuration sections.
997
+ #
998
+ # @return [Types::ImportGameConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
999
+ #
1000
+ # * {Types::ImportGameConfigurationResult#game_configuration #game_configuration} => Types::GameConfigurationDetails
1001
+ #
1002
+ # @example Request syntax with placeholder values
1003
+ #
1004
+ # resp = client.import_game_configuration({
1005
+ # game_name: "GameName", # required
1006
+ # import_source: { # required
1007
+ # file: "data", # required
1008
+ # },
1009
+ # })
1010
+ #
1011
+ # @example Response structure
1012
+ #
1013
+ # resp.game_configuration.created #=> Time
1014
+ # resp.game_configuration.last_updated #=> Time
1015
+ # resp.game_configuration.sections #=> Hash
1016
+ # resp.game_configuration.sections["SectionName"].name #=> String
1017
+ # resp.game_configuration.sections["SectionName"].size #=> Integer
1018
+ #
1019
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ImportGameConfiguration AWS API Documentation
1020
+ #
1021
+ # @overload import_game_configuration(params = {})
1022
+ # @param [Hash] params ({})
1023
+ def import_game_configuration(params = {}, options = {})
1024
+ req = build_request(:import_game_configuration, params)
1025
+ req.send_request(options)
1026
+ end
1027
+
1028
+ # Gets a paginated list of available versions for the extension.
1029
+ #
1030
+ # Each time an API change is made to an extension, the version is
1031
+ # incremented. The list retrieved by this operation shows the versions
1032
+ # that are currently available.
1033
+ #
1034
+ # @option params [Integer] :max_results
1035
+ # The maximum number of results to return.
1036
+ #
1037
+ # Use this parameter with NextToken to get results as a set of
1038
+ # sequential pages.
1039
+ #
1040
+ # @option params [required, String] :name
1041
+ # The name of the extension.
1042
+ #
1043
+ # @option params [required, String] :namespace
1044
+ # The namespace (qualifier) of the extension.
1045
+ #
1046
+ # @option params [String] :next_token
1047
+ # The token that indicates the start of the next sequential page of
1048
+ # results.
1049
+ #
1050
+ # Use the token that is returned with a previous call to this operation.
1051
+ # To start at the beginning of the result set, do not specify a value.
1052
+ #
1053
+ # @return [Types::ListExtensionVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1054
+ #
1055
+ # * {Types::ListExtensionVersionsResult#extension_versions #extension_versions} => Array&lt;Types::ExtensionVersionDetails&gt;
1056
+ # * {Types::ListExtensionVersionsResult#next_token #next_token} => String
1057
+ #
1058
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1059
+ #
1060
+ # @example Request syntax with placeholder values
1061
+ #
1062
+ # resp = client.list_extension_versions({
1063
+ # max_results: 1,
1064
+ # name: "ExtensionName", # required
1065
+ # namespace: "ExtensionNamespace", # required
1066
+ # next_token: "NextToken",
1067
+ # })
1068
+ #
1069
+ # @example Response structure
1070
+ #
1071
+ # resp.extension_versions #=> Array
1072
+ # resp.extension_versions[0].name #=> String
1073
+ # resp.extension_versions[0].namespace #=> String
1074
+ # resp.extension_versions[0].schema #=> String
1075
+ # resp.extension_versions[0].version #=> String
1076
+ # resp.next_token #=> String
1077
+ #
1078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListExtensionVersions AWS API Documentation
1079
+ #
1080
+ # @overload list_extension_versions(params = {})
1081
+ # @param [Hash] params ({})
1082
+ def list_extension_versions(params = {}, options = {})
1083
+ req = build_request(:list_extension_versions, params)
1084
+ req.send_request(options)
1085
+ end
1086
+
1087
+ # Gets a paginated list of available extensions.
1088
+ #
1089
+ # Extensions provide features that games can use from scripts.
1090
+ #
1091
+ # @option params [Integer] :max_results
1092
+ # The maximum number of results to return.
1093
+ #
1094
+ # Use this parameter with NextToken to get results as a set of
1095
+ # sequential pages.
1096
+ #
1097
+ # @option params [String] :next_token
1098
+ # The token that indicates the start of the next sequential page of
1099
+ # results.
1100
+ #
1101
+ # Use the token that is returned with a previous call to this operation.
1102
+ # To start at the beginning of the result set, do not specify a value.
1103
+ #
1104
+ # @return [Types::ListExtensionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
+ #
1106
+ # * {Types::ListExtensionsResult#extensions #extensions} => Array&lt;Types::ExtensionDetails&gt;
1107
+ # * {Types::ListExtensionsResult#next_token #next_token} => String
1108
+ #
1109
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1110
+ #
1111
+ # @example Request syntax with placeholder values
1112
+ #
1113
+ # resp = client.list_extensions({
1114
+ # max_results: 1,
1115
+ # next_token: "NextToken",
1116
+ # })
1117
+ #
1118
+ # @example Response structure
1119
+ #
1120
+ # resp.extensions #=> Array
1121
+ # resp.extensions[0].description #=> String
1122
+ # resp.extensions[0].name #=> String
1123
+ # resp.extensions[0].namespace #=> String
1124
+ # resp.next_token #=> String
1125
+ #
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListExtensions AWS API Documentation
1127
+ #
1128
+ # @overload list_extensions(params = {})
1129
+ # @param [Hash] params ({})
1130
+ def list_extensions(params = {}, options = {})
1131
+ req = build_request(:list_extensions, params)
1132
+ req.send_request(options)
1133
+ end
1134
+
1135
+ # Gets a paginated list of games.
1136
+ #
1137
+ # @option params [Integer] :max_results
1138
+ # The maximum number of results to return.
1139
+ #
1140
+ # Use this parameter with NextToken to get results as a set of
1141
+ # sequential pages.
1142
+ #
1143
+ # @option params [String] :next_token
1144
+ # The token that indicates the start of the next sequential page of
1145
+ # results.
1146
+ #
1147
+ # Use the token that is returned with a previous call to this operation.
1148
+ # To start at the beginning of the result set, do not specify a value.
1149
+ #
1150
+ # @return [Types::ListGamesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1151
+ #
1152
+ # * {Types::ListGamesResult#games #games} => Array&lt;Types::GameSummary&gt;
1153
+ # * {Types::ListGamesResult#next_token #next_token} => String
1154
+ #
1155
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1156
+ #
1157
+ # @example Request syntax with placeholder values
1158
+ #
1159
+ # resp = client.list_games({
1160
+ # max_results: 1,
1161
+ # next_token: "NextToken",
1162
+ # })
1163
+ #
1164
+ # @example Response structure
1165
+ #
1166
+ # resp.games #=> Array
1167
+ # resp.games[0].description #=> String
1168
+ # resp.games[0].name #=> String
1169
+ # resp.games[0].state #=> String, one of "ACTIVE", "DELETING"
1170
+ # resp.games[0].tags #=> Hash
1171
+ # resp.games[0].tags["TagKey"] #=> String
1172
+ # resp.next_token #=> String
1173
+ #
1174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListGames AWS API Documentation
1175
+ #
1176
+ # @overload list_games(params = {})
1177
+ # @param [Hash] params ({})
1178
+ def list_games(params = {}, options = {})
1179
+ req = build_request(:list_games, params)
1180
+ req.send_request(options)
1181
+ end
1182
+
1183
+ # Gets a paginated list of code generation jobs for a snapshot.
1184
+ #
1185
+ # @option params [required, String] :game_name
1186
+ # The name of the game.
1187
+ #
1188
+ # @option params [Integer] :max_results
1189
+ # The maximum number of results to return.
1190
+ #
1191
+ # Use this parameter with NextToken to get results as a set of
1192
+ # sequential pages.
1193
+ #
1194
+ # @option params [String] :next_token
1195
+ # The token that indicates the start of the next sequential page of
1196
+ # results.
1197
+ #
1198
+ # Use the token that is returned with a previous call to this operation.
1199
+ # To start at the beginning of the result set, do not specify a value.
1200
+ #
1201
+ # @option params [required, String] :snapshot_id
1202
+ # The identifier of the snapshot.
1203
+ #
1204
+ # @return [Types::ListGeneratedCodeJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1205
+ #
1206
+ # * {Types::ListGeneratedCodeJobsResult#generated_code_jobs #generated_code_jobs} => Array&lt;Types::GeneratedCodeJobDetails&gt;
1207
+ # * {Types::ListGeneratedCodeJobsResult#next_token #next_token} => String
1208
+ #
1209
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1210
+ #
1211
+ # @example Request syntax with placeholder values
1212
+ #
1213
+ # resp = client.list_generated_code_jobs({
1214
+ # game_name: "GameName", # required
1215
+ # max_results: 1,
1216
+ # next_token: "NextToken",
1217
+ # snapshot_id: "SnapshotId", # required
1218
+ # })
1219
+ #
1220
+ # @example Response structure
1221
+ #
1222
+ # resp.generated_code_jobs #=> Array
1223
+ # resp.generated_code_jobs[0].description #=> String
1224
+ # resp.generated_code_jobs[0].expiration_time #=> Time
1225
+ # resp.generated_code_jobs[0].generated_code_job_id #=> String
1226
+ # resp.generated_code_jobs[0].s3_url #=> String
1227
+ # resp.generated_code_jobs[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED", "PENDING"
1228
+ # resp.next_token #=> String
1229
+ #
1230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListGeneratedCodeJobs AWS API Documentation
1231
+ #
1232
+ # @overload list_generated_code_jobs(params = {})
1233
+ # @param [Hash] params ({})
1234
+ def list_generated_code_jobs(params = {}, options = {})
1235
+ req = build_request(:list_generated_code_jobs, params)
1236
+ req.send_request(options)
1237
+ end
1238
+
1239
+ # Gets a paginated list of snapshot summaries from the game.
1240
+ #
1241
+ # @option params [required, String] :game_name
1242
+ # The name of the game.
1243
+ #
1244
+ # @option params [Integer] :max_results
1245
+ # The maximum number of results to return.
1246
+ #
1247
+ # Use this parameter with NextToken to get results as a set of
1248
+ # sequential pages.
1249
+ #
1250
+ # @option params [String] :next_token
1251
+ # The token that indicates the start of the next sequential page of
1252
+ # results.
1253
+ #
1254
+ # Use the token that is returned with a previous call to this operation.
1255
+ # To start at the beginning of the result set, do not specify a value.
1256
+ #
1257
+ # @return [Types::ListSnapshotsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1258
+ #
1259
+ # * {Types::ListSnapshotsResult#next_token #next_token} => String
1260
+ # * {Types::ListSnapshotsResult#snapshots #snapshots} => Array&lt;Types::SnapshotSummary&gt;
1261
+ #
1262
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1263
+ #
1264
+ # @example Request syntax with placeholder values
1265
+ #
1266
+ # resp = client.list_snapshots({
1267
+ # game_name: "GameName", # required
1268
+ # max_results: 1,
1269
+ # next_token: "NextToken",
1270
+ # })
1271
+ #
1272
+ # @example Response structure
1273
+ #
1274
+ # resp.next_token #=> String
1275
+ # resp.snapshots #=> Array
1276
+ # resp.snapshots[0].created #=> Time
1277
+ # resp.snapshots[0].description #=> String
1278
+ # resp.snapshots[0].id #=> String
1279
+ # resp.snapshots[0].last_updated #=> Time
1280
+ #
1281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListSnapshots AWS API Documentation
1282
+ #
1283
+ # @overload list_snapshots(params = {})
1284
+ # @param [Hash] params ({})
1285
+ def list_snapshots(params = {}, options = {})
1286
+ req = build_request(:list_snapshots, params)
1287
+ req.send_request(options)
1288
+ end
1289
+
1290
+ # Gets a paginated list of stage deployment summaries from the game.
1291
+ #
1292
+ # @option params [required, String] :game_name
1293
+ # The name of the game.
1294
+ #
1295
+ # @option params [Integer] :max_results
1296
+ # The maximum number of results to return.
1297
+ #
1298
+ # Use this parameter with NextToken to get results as a set of
1299
+ # sequential pages.
1300
+ #
1301
+ # @option params [String] :next_token
1302
+ # The token that indicates the start of the next sequential page of
1303
+ # results.
1304
+ #
1305
+ # Use the token that is returned with a previous call to this operation.
1306
+ # To start at the beginning of the result set, do not specify a value.
1307
+ #
1308
+ # @option params [required, String] :stage_name
1309
+ # The name of the stage.
1310
+ #
1311
+ # @return [Types::ListStageDeploymentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1312
+ #
1313
+ # * {Types::ListStageDeploymentsResult#next_token #next_token} => String
1314
+ # * {Types::ListStageDeploymentsResult#stage_deployments #stage_deployments} => Array&lt;Types::StageDeploymentSummary&gt;
1315
+ #
1316
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1317
+ #
1318
+ # @example Request syntax with placeholder values
1319
+ #
1320
+ # resp = client.list_stage_deployments({
1321
+ # game_name: "GameName", # required
1322
+ # max_results: 1,
1323
+ # next_token: "NextToken",
1324
+ # stage_name: "StageName", # required
1325
+ # })
1326
+ #
1327
+ # @example Response structure
1328
+ #
1329
+ # resp.next_token #=> String
1330
+ # resp.stage_deployments #=> Array
1331
+ # resp.stage_deployments[0].deployment_action #=> String, one of "DEPLOY", "UNDEPLOY"
1332
+ # resp.stage_deployments[0].deployment_id #=> String
1333
+ # resp.stage_deployments[0].deployment_state #=> String, one of "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"
1334
+ # resp.stage_deployments[0].last_updated #=> Time
1335
+ # resp.stage_deployments[0].snapshot_id #=> String
1336
+ #
1337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListStageDeployments AWS API Documentation
1338
+ #
1339
+ # @overload list_stage_deployments(params = {})
1340
+ # @param [Hash] params ({})
1341
+ def list_stage_deployments(params = {}, options = {})
1342
+ req = build_request(:list_stage_deployments, params)
1343
+ req.send_request(options)
1344
+ end
1345
+
1346
+ # Gets a paginated list of stage summaries from the game.
1347
+ #
1348
+ # @option params [required, String] :game_name
1349
+ # The name of the game.
1350
+ #
1351
+ # @option params [Integer] :max_results
1352
+ # The maximum number of results to return.
1353
+ #
1354
+ # Use this parameter with NextToken to get results as a set of
1355
+ # sequential pages.
1356
+ #
1357
+ # @option params [String] :next_token
1358
+ # The token that indicates the start of the next sequential page of
1359
+ # results.
1360
+ #
1361
+ # Use the token that is returned with a previous call to this operation.
1362
+ # To start at the beginning of the result set, do not specify a value.
1363
+ #
1364
+ # @return [Types::ListStagesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1365
+ #
1366
+ # * {Types::ListStagesResult#next_token #next_token} => String
1367
+ # * {Types::ListStagesResult#stages #stages} => Array&lt;Types::StageSummary&gt;
1368
+ #
1369
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1370
+ #
1371
+ # @example Request syntax with placeholder values
1372
+ #
1373
+ # resp = client.list_stages({
1374
+ # game_name: "GameName", # required
1375
+ # max_results: 1,
1376
+ # next_token: "NextToken",
1377
+ # })
1378
+ #
1379
+ # @example Response structure
1380
+ #
1381
+ # resp.next_token #=> String
1382
+ # resp.stages #=> Array
1383
+ # resp.stages[0].description #=> String
1384
+ # resp.stages[0].game_key #=> String
1385
+ # resp.stages[0].name #=> String
1386
+ # resp.stages[0].state #=> String, one of "ACTIVE", "DELETING"
1387
+ # resp.stages[0].tags #=> Hash
1388
+ # resp.stages[0].tags["TagKey"] #=> String
1389
+ #
1390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListStages AWS API Documentation
1391
+ #
1392
+ # @overload list_stages(params = {})
1393
+ # @param [Hash] params ({})
1394
+ def list_stages(params = {}, options = {})
1395
+ req = build_request(:list_stages, params)
1396
+ req.send_request(options)
1397
+ end
1398
+
1399
+ # Lists the tags associated with a GameSparks resource.
1400
+ #
1401
+ # @option params [required, String] :resource_arn
1402
+ # The Amazon Resource Name (ARN) of the GameSparks resource.
1403
+ #
1404
+ # @return [Types::ListTagsForResourceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1405
+ #
1406
+ # * {Types::ListTagsForResourceResult#tags #tags} => Hash&lt;String,String&gt;
1407
+ #
1408
+ # @example Request syntax with placeholder values
1409
+ #
1410
+ # resp = client.list_tags_for_resource({
1411
+ # resource_arn: "ResourceArn", # required
1412
+ # })
1413
+ #
1414
+ # @example Response structure
1415
+ #
1416
+ # resp.tags #=> Hash
1417
+ # resp.tags["TagKey"] #=> String
1418
+ #
1419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/ListTagsForResource AWS API Documentation
1420
+ #
1421
+ # @overload list_tags_for_resource(params = {})
1422
+ # @param [Hash] params ({})
1423
+ def list_tags_for_resource(params = {}, options = {})
1424
+ req = build_request(:list_tags_for_resource, params)
1425
+ req.send_request(options)
1426
+ end
1427
+
1428
+ # Starts an asynchronous process that generates client code for
1429
+ # system-defined and custom messages. The resulting code is collected as
1430
+ # a .zip file and uploaded to a pre-signed Amazon S3 URL.
1431
+ #
1432
+ # @option params [required, String] :game_name
1433
+ # The name of the game.
1434
+ #
1435
+ # @option params [required, Types::Generator] :generator
1436
+ # Properties of the generator to use for the job.
1437
+ #
1438
+ # @option params [required, String] :snapshot_id
1439
+ # The identifier of the snapshot for which to generate code.
1440
+ #
1441
+ # @return [Types::StartGeneratedCodeJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1442
+ #
1443
+ # * {Types::StartGeneratedCodeJobResult#generated_code_job_id #generated_code_job_id} => String
1444
+ #
1445
+ # @example Request syntax with placeholder values
1446
+ #
1447
+ # resp = client.start_generated_code_job({
1448
+ # game_name: "GameName", # required
1449
+ # generator: { # required
1450
+ # game_sdk_version: "GameSdkVersion",
1451
+ # language: "Language",
1452
+ # target_platform: "TargetPlatform",
1453
+ # },
1454
+ # snapshot_id: "SnapshotId", # required
1455
+ # })
1456
+ #
1457
+ # @example Response structure
1458
+ #
1459
+ # resp.generated_code_job_id #=> String
1460
+ #
1461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/StartGeneratedCodeJob AWS API Documentation
1462
+ #
1463
+ # @overload start_generated_code_job(params = {})
1464
+ # @param [Hash] params ({})
1465
+ def start_generated_code_job(params = {}, options = {})
1466
+ req = build_request(:start_generated_code_job, params)
1467
+ req.send_request(options)
1468
+ end
1469
+
1470
+ # Deploys a snapshot to the stage and creates a new game runtime.
1471
+ #
1472
+ # After you call this operation, you can check the deployment status by
1473
+ # using `GetStageDeployment`.
1474
+ #
1475
+ # If there are any players connected to the previous game runtime, then
1476
+ # both runtimes persist. Existing connections to the previous runtime
1477
+ # are maintained. When players disconnect and reconnect, they connect to
1478
+ # the new runtime. After there are no connections to the previous game
1479
+ # runtime, it is deleted.
1480
+ #
1481
+ # @option params [String] :client_token
1482
+ # A client-defined token. With an active client token in the request,
1483
+ # this action is idempotent.
1484
+ #
1485
+ # @option params [required, String] :game_name
1486
+ # The name of the game.
1487
+ #
1488
+ # @option params [required, String] :snapshot_id
1489
+ # The identifier of the snapshot to deploy.
1490
+ #
1491
+ # @option params [required, String] :stage_name
1492
+ # The name of the stage to deploy the snapshot onto.
1493
+ #
1494
+ # @return [Types::StartStageDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1495
+ #
1496
+ # * {Types::StartStageDeploymentResult#stage_deployment #stage_deployment} => Types::StageDeploymentDetails
1497
+ #
1498
+ # @example Request syntax with placeholder values
1499
+ #
1500
+ # resp = client.start_stage_deployment({
1501
+ # client_token: "ClientToken",
1502
+ # game_name: "GameName", # required
1503
+ # snapshot_id: "SnapshotId", # required
1504
+ # stage_name: "StageName", # required
1505
+ # })
1506
+ #
1507
+ # @example Response structure
1508
+ #
1509
+ # resp.stage_deployment.created #=> Time
1510
+ # resp.stage_deployment.deployment_action #=> String, one of "DEPLOY", "UNDEPLOY"
1511
+ # resp.stage_deployment.deployment_id #=> String
1512
+ # resp.stage_deployment.deployment_state #=> String, one of "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"
1513
+ # resp.stage_deployment.last_updated #=> Time
1514
+ # resp.stage_deployment.snapshot_id #=> String
1515
+ #
1516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/StartStageDeployment AWS API Documentation
1517
+ #
1518
+ # @overload start_stage_deployment(params = {})
1519
+ # @param [Hash] params ({})
1520
+ def start_stage_deployment(params = {}, options = {})
1521
+ req = build_request(:start_stage_deployment, params)
1522
+ req.send_request(options)
1523
+ end
1524
+
1525
+ # Adds tags to a GameSparks resource.
1526
+ #
1527
+ # @option params [required, String] :resource_arn
1528
+ # The Amazon Resource Name (ARN) of the resource to add the tags to.
1529
+ #
1530
+ # @option params [required, Hash<String,String>] :tags
1531
+ # The tags to add to the resource.
1532
+ #
1533
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1534
+ #
1535
+ # @example Request syntax with placeholder values
1536
+ #
1537
+ # resp = client.tag_resource({
1538
+ # resource_arn: "ResourceArn", # required
1539
+ # tags: { # required
1540
+ # "TagKey" => "TagValue",
1541
+ # },
1542
+ # })
1543
+ #
1544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/TagResource AWS API Documentation
1545
+ #
1546
+ # @overload tag_resource(params = {})
1547
+ # @param [Hash] params ({})
1548
+ def tag_resource(params = {}, options = {})
1549
+ req = build_request(:tag_resource, params)
1550
+ req.send_request(options)
1551
+ end
1552
+
1553
+ # Removes tags from a GameSparks resource.
1554
+ #
1555
+ # @option params [required, String] :resource_arn
1556
+ # The Amazon Resource Name (ARN) of the resource to remove the tags
1557
+ # from.
1558
+ #
1559
+ # @option params [required, Array<String>] :tag_keys
1560
+ # The keys of the tags to remove.
1561
+ #
1562
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1563
+ #
1564
+ # @example Request syntax with placeholder values
1565
+ #
1566
+ # resp = client.untag_resource({
1567
+ # resource_arn: "ResourceArn", # required
1568
+ # tag_keys: ["TagKey"], # required
1569
+ # })
1570
+ #
1571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/UntagResource AWS API Documentation
1572
+ #
1573
+ # @overload untag_resource(params = {})
1574
+ # @param [Hash] params ({})
1575
+ def untag_resource(params = {}, options = {})
1576
+ req = build_request(:untag_resource, params)
1577
+ req.send_request(options)
1578
+ end
1579
+
1580
+ # Updates details of the game.
1581
+ #
1582
+ # @option params [String] :description
1583
+ # The description of the game.
1584
+ #
1585
+ # @option params [required, String] :game_name
1586
+ # The name of the game.
1587
+ #
1588
+ # @return [Types::UpdateGameResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1589
+ #
1590
+ # * {Types::UpdateGameResult#game #game} => Types::GameDetails
1591
+ #
1592
+ # @example Request syntax with placeholder values
1593
+ #
1594
+ # resp = client.update_game({
1595
+ # description: "GameDescription",
1596
+ # game_name: "GameName", # required
1597
+ # })
1598
+ #
1599
+ # @example Response structure
1600
+ #
1601
+ # resp.game.arn #=> String
1602
+ # resp.game.created #=> Time
1603
+ # resp.game.description #=> String
1604
+ # resp.game.enable_termination_protection #=> Boolean
1605
+ # resp.game.last_updated #=> Time
1606
+ # resp.game.name #=> String
1607
+ # resp.game.state #=> String, one of "ACTIVE", "DELETING"
1608
+ # resp.game.tags #=> Hash
1609
+ # resp.game.tags["TagKey"] #=> String
1610
+ #
1611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/UpdateGame AWS API Documentation
1612
+ #
1613
+ # @overload update_game(params = {})
1614
+ # @param [Hash] params ({})
1615
+ def update_game(params = {}, options = {})
1616
+ req = build_request(:update_game, params)
1617
+ req.send_request(options)
1618
+ end
1619
+
1620
+ # Updates one or more sections of the game configuration.
1621
+ #
1622
+ # @option params [required, String] :game_name
1623
+ # The name of the game.
1624
+ #
1625
+ # @option params [required, Array<Types::SectionModification>] :modifications
1626
+ # The list of modifications to make.
1627
+ #
1628
+ # @return [Types::UpdateGameConfigurationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1629
+ #
1630
+ # * {Types::UpdateGameConfigurationResult#game_configuration #game_configuration} => Types::GameConfigurationDetails
1631
+ #
1632
+ # @example Request syntax with placeholder values
1633
+ #
1634
+ # resp = client.update_game_configuration({
1635
+ # game_name: "GameName", # required
1636
+ # modifications: [ # required
1637
+ # {
1638
+ # operation: "ADD", # required, accepts ADD, REMOVE, REPLACE
1639
+ # path: "Path", # required
1640
+ # section: "SectionName", # required
1641
+ # value: {
1642
+ # },
1643
+ # },
1644
+ # ],
1645
+ # })
1646
+ #
1647
+ # @example Response structure
1648
+ #
1649
+ # resp.game_configuration.created #=> Time
1650
+ # resp.game_configuration.last_updated #=> Time
1651
+ # resp.game_configuration.sections #=> Hash
1652
+ # resp.game_configuration.sections["SectionName"].name #=> String
1653
+ # resp.game_configuration.sections["SectionName"].size #=> Integer
1654
+ #
1655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/UpdateGameConfiguration AWS API Documentation
1656
+ #
1657
+ # @overload update_game_configuration(params = {})
1658
+ # @param [Hash] params ({})
1659
+ def update_game_configuration(params = {}, options = {})
1660
+ req = build_request(:update_game_configuration, params)
1661
+ req.send_request(options)
1662
+ end
1663
+
1664
+ # Updates the metadata of a GameSparks snapshot.
1665
+ #
1666
+ # @option params [String] :description
1667
+ # The description of the snapshot.
1668
+ #
1669
+ # @option params [required, String] :game_name
1670
+ # The name of the game.
1671
+ #
1672
+ # @option params [required, String] :snapshot_id
1673
+ # The identifier of the snapshot.
1674
+ #
1675
+ # @return [Types::UpdateSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1676
+ #
1677
+ # * {Types::UpdateSnapshotResult#snapshot #snapshot} => Types::SnapshotDetails
1678
+ #
1679
+ # @example Request syntax with placeholder values
1680
+ #
1681
+ # resp = client.update_snapshot({
1682
+ # description: "SnapshotDescription",
1683
+ # game_name: "GameName", # required
1684
+ # snapshot_id: "SnapshotId", # required
1685
+ # })
1686
+ #
1687
+ # @example Response structure
1688
+ #
1689
+ # resp.snapshot.created #=> Time
1690
+ # resp.snapshot.description #=> String
1691
+ # resp.snapshot.id #=> String
1692
+ # resp.snapshot.last_updated #=> Time
1693
+ # resp.snapshot.sections #=> Hash
1694
+ # resp.snapshot.sections["SectionName"].name #=> String
1695
+ # resp.snapshot.sections["SectionName"].size #=> Integer
1696
+ #
1697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/UpdateSnapshot AWS API Documentation
1698
+ #
1699
+ # @overload update_snapshot(params = {})
1700
+ # @param [Hash] params ({})
1701
+ def update_snapshot(params = {}, options = {})
1702
+ req = build_request(:update_snapshot, params)
1703
+ req.send_request(options)
1704
+ end
1705
+
1706
+ # Updates the metadata of a stage.
1707
+ #
1708
+ # @option params [String] :description
1709
+ # The description of the stage.
1710
+ #
1711
+ # @option params [required, String] :game_name
1712
+ # The name of the game.
1713
+ #
1714
+ # @option params [String] :role
1715
+ # The Amazon Resource Name (ARN) of the role to use for the game
1716
+ # snapshots deployed to this stage.
1717
+ #
1718
+ # @option params [required, String] :stage_name
1719
+ # The name of the stage.
1720
+ #
1721
+ # @return [Types::UpdateStageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1722
+ #
1723
+ # * {Types::UpdateStageResult#stage #stage} => Types::StageDetails
1724
+ #
1725
+ # @example Request syntax with placeholder values
1726
+ #
1727
+ # resp = client.update_stage({
1728
+ # description: "StageDescription",
1729
+ # game_name: "GameName", # required
1730
+ # role: "RoleARN",
1731
+ # stage_name: "StageName", # required
1732
+ # })
1733
+ #
1734
+ # @example Response structure
1735
+ #
1736
+ # resp.stage.arn #=> String
1737
+ # resp.stage.created #=> Time
1738
+ # resp.stage.description #=> String
1739
+ # resp.stage.game_key #=> String
1740
+ # resp.stage.last_updated #=> Time
1741
+ # resp.stage.log_group #=> String
1742
+ # resp.stage.name #=> String
1743
+ # resp.stage.role #=> String
1744
+ # resp.stage.state #=> String, one of "ACTIVE", "DELETING"
1745
+ # resp.stage.tags #=> Hash
1746
+ # resp.stage.tags["TagKey"] #=> String
1747
+ #
1748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamesparks-2021-08-17/UpdateStage AWS API Documentation
1749
+ #
1750
+ # @overload update_stage(params = {})
1751
+ # @param [Hash] params ({})
1752
+ def update_stage(params = {}, options = {})
1753
+ req = build_request(:update_stage, params)
1754
+ req.send_request(options)
1755
+ end
1756
+
1757
+ # @!endgroup
1758
+
1759
+ # @param params ({})
1760
+ # @api private
1761
+ def build_request(operation_name, params = {})
1762
+ handlers = @handlers.for(operation_name)
1763
+ context = Seahorse::Client::RequestContext.new(
1764
+ operation_name: operation_name,
1765
+ operation: config.api.operation(operation_name),
1766
+ client: self,
1767
+ params: params,
1768
+ config: config)
1769
+ context[:gem_name] = 'aws-sdk-gamesparks'
1770
+ context[:gem_version] = '1.0.0'
1771
+ Seahorse::Client::Request.new(handlers, context)
1772
+ end
1773
+
1774
+ # @api private
1775
+ # @deprecated
1776
+ def waiter_names
1777
+ []
1778
+ end
1779
+
1780
+ class << self
1781
+
1782
+ # @api private
1783
+ attr_reader :identifier
1784
+
1785
+ # @api private
1786
+ def errors_module
1787
+ Errors
1788
+ end
1789
+
1790
+ end
1791
+ end
1792
+ end