aws-sdk-gamelift 1.26.0 → 1.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-gamelift.rb +1 -1
- data/lib/aws-sdk-gamelift/client.rb +973 -662
- data/lib/aws-sdk-gamelift/client_api.rb +130 -10
- data/lib/aws-sdk-gamelift/errors.rb +16 -0
- data/lib/aws-sdk-gamelift/types.rb +1445 -886
- metadata +2 -2
@@ -170,6 +170,22 @@ module Aws::GameLift
|
|
170
170
|
|
171
171
|
end
|
172
172
|
|
173
|
+
class TaggingFailedException < ServiceError
|
174
|
+
|
175
|
+
# @param [Seahorse::Client::RequestContext] context
|
176
|
+
# @param [String] message
|
177
|
+
# @param [Aws::GameLift::Types::TaggingFailedException] data
|
178
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
179
|
+
super(context, message, data)
|
180
|
+
end
|
181
|
+
|
182
|
+
# @return [String]
|
183
|
+
def message
|
184
|
+
@message || @data[:message]
|
185
|
+
end
|
186
|
+
|
187
|
+
end
|
188
|
+
|
173
189
|
class TerminalRoutingStrategyException < ServiceError
|
174
190
|
|
175
191
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -20,12 +20,12 @@ module Aws::GameLift
|
|
20
20
|
# }
|
21
21
|
#
|
22
22
|
# @!attribute [rw] ticket_id
|
23
|
-
#
|
23
|
+
# A unique identifier for a matchmaking ticket. The ticket must be in
|
24
24
|
# status `REQUIRES_ACCEPTANCE`; otherwise this request will fail.
|
25
25
|
# @return [String]
|
26
26
|
#
|
27
27
|
# @!attribute [rw] player_ids
|
28
|
-
#
|
28
|
+
# A unique identifier for a player delivering the response. This
|
29
29
|
# parameter can include one or multiple player IDs.
|
30
30
|
# @return [Array<String>]
|
31
31
|
#
|
@@ -46,7 +46,7 @@ module Aws::GameLift
|
|
46
46
|
#
|
47
47
|
class AcceptMatchOutput < Aws::EmptyStructure; end
|
48
48
|
|
49
|
-
# Properties
|
49
|
+
# Properties that describe an alias resource.
|
50
50
|
#
|
51
51
|
# * CreateAlias
|
52
52
|
#
|
@@ -61,39 +61,45 @@ module Aws::GameLift
|
|
61
61
|
# * ResolveAlias
|
62
62
|
#
|
63
63
|
# @!attribute [rw] alias_id
|
64
|
-
#
|
65
|
-
#
|
64
|
+
# A unique identifier for an alias. Alias IDs are unique within a
|
65
|
+
# Region.
|
66
66
|
# @return [String]
|
67
67
|
#
|
68
68
|
# @!attribute [rw] name
|
69
|
-
#
|
69
|
+
# A descriptive label that is associated with an alias. Alias names do
|
70
70
|
# not need to be unique.
|
71
71
|
# @return [String]
|
72
72
|
#
|
73
73
|
# @!attribute [rw] alias_arn
|
74
|
-
#
|
75
|
-
#
|
74
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift alias
|
75
|
+
# resource and uniquely identifies it. ARNs are unique across all
|
76
|
+
# Regions.. In a GameLift alias ARN, the resource ID matches the alias
|
77
|
+
# ID value.
|
78
|
+
#
|
79
|
+
#
|
80
|
+
#
|
81
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
76
82
|
# @return [String]
|
77
83
|
#
|
78
84
|
# @!attribute [rw] description
|
79
|
-
#
|
85
|
+
# A human-readable description of an alias.
|
80
86
|
# @return [String]
|
81
87
|
#
|
82
88
|
# @!attribute [rw] routing_strategy
|
83
|
-
#
|
84
|
-
#
|
89
|
+
# The routing configuration, including routing type and fleet target,
|
90
|
+
# for the alias.
|
85
91
|
# @return [Types::RoutingStrategy]
|
86
92
|
#
|
87
93
|
# @!attribute [rw] creation_time
|
88
|
-
#
|
89
|
-
# number expressed in Unix time as milliseconds (for example
|
94
|
+
# A time stamp indicating when this data object was created. Format is
|
95
|
+
# a number expressed in Unix time as milliseconds (for example
|
90
96
|
# "1469498468.057").
|
91
97
|
# @return [Time]
|
92
98
|
#
|
93
99
|
# @!attribute [rw] last_updated_time
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
100
|
+
# The time that this data object was last modified. Format is a number
|
101
|
+
# expressed in Unix time as milliseconds (for example
|
102
|
+
# "1469498468.057").
|
97
103
|
# @return [Time]
|
98
104
|
#
|
99
105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Alias AWS API Documentation
|
@@ -109,7 +115,7 @@ module Aws::GameLift
|
|
109
115
|
include Aws::Structure
|
110
116
|
end
|
111
117
|
|
112
|
-
# Values for use in Player attribute key
|
118
|
+
# Values for use in Player attribute key-value pairs. This object lets
|
113
119
|
# you specify an attribute value using any of the valid data types:
|
114
120
|
# string, number, string array, or data map. Each `AttributeValue`
|
115
121
|
# object can use only one of the available properties.
|
@@ -199,19 +205,30 @@ module Aws::GameLift
|
|
199
205
|
# * DeleteBuild
|
200
206
|
#
|
201
207
|
# @!attribute [rw] build_id
|
202
|
-
#
|
208
|
+
# A unique identifier for a build.
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] build_arn
|
212
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift build
|
213
|
+
# resource and uniquely identifies it. ARNs are unique across all
|
214
|
+
# Regions. In a GameLift build ARN, the resource ID matches the
|
215
|
+
# *BuildId* value.
|
216
|
+
#
|
217
|
+
#
|
218
|
+
#
|
219
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
203
220
|
# @return [String]
|
204
221
|
#
|
205
222
|
# @!attribute [rw] name
|
206
|
-
#
|
223
|
+
# A descriptive label that is associated with a build. Build names do
|
207
224
|
# not need to be unique. It can be set using CreateBuild or
|
208
225
|
# UpdateBuild.
|
209
226
|
# @return [String]
|
210
227
|
#
|
211
228
|
# @!attribute [rw] version
|
212
|
-
# Version that is associated with a build or script.
|
213
|
-
# do not need to be unique. This value can be set
|
214
|
-
# UpdateBuild.
|
229
|
+
# Version information that is associated with a build or script.
|
230
|
+
# Version strings do not need to be unique. This value can be set
|
231
|
+
# using CreateBuild or UpdateBuild.
|
215
232
|
# @return [String]
|
216
233
|
#
|
217
234
|
# @!attribute [rw] status
|
@@ -252,6 +269,7 @@ module Aws::GameLift
|
|
252
269
|
#
|
253
270
|
class Build < Struct.new(
|
254
271
|
:build_id,
|
272
|
+
:build_arn,
|
255
273
|
:name,
|
256
274
|
:version,
|
257
275
|
:status,
|
@@ -261,6 +279,17 @@ module Aws::GameLift
|
|
261
279
|
include Aws::Structure
|
262
280
|
end
|
263
281
|
|
282
|
+
# Information about the use of a TLS/SSL certificate for a fleet. TLS
|
283
|
+
# certificate generation is enabled at the fleet level, with one
|
284
|
+
# certificate generated for the fleet. When this feature is enabled, the
|
285
|
+
# certificate can be retrieved using the [GameLift Server SDK][1] call
|
286
|
+
# `GetInstanceCertificate`. All instances in a fleet share the same
|
287
|
+
# certificate.
|
288
|
+
#
|
289
|
+
#
|
290
|
+
#
|
291
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html
|
292
|
+
#
|
264
293
|
# @note When making an API call, you may pass CertificateConfiguration
|
265
294
|
# data as a hash:
|
266
295
|
#
|
@@ -269,6 +298,7 @@ module Aws::GameLift
|
|
269
298
|
# }
|
270
299
|
#
|
271
300
|
# @!attribute [rw] certificate_type
|
301
|
+
# Indicates whether a TLS/SSL certificate was generated for a fleet.
|
272
302
|
# @return [String]
|
273
303
|
#
|
274
304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CertificateConfiguration AWS API Documentation
|
@@ -305,35 +335,57 @@ module Aws::GameLift
|
|
305
335
|
# fleet_id: "FleetId",
|
306
336
|
# message: "FreeText",
|
307
337
|
# },
|
338
|
+
# tags: [
|
339
|
+
# {
|
340
|
+
# key: "TagKey", # required
|
341
|
+
# value: "TagValue", # required
|
342
|
+
# },
|
343
|
+
# ],
|
308
344
|
# }
|
309
345
|
#
|
310
346
|
# @!attribute [rw] name
|
311
|
-
#
|
347
|
+
# A descriptive label that is associated with an alias. Alias names do
|
312
348
|
# not need to be unique.
|
313
349
|
# @return [String]
|
314
350
|
#
|
315
351
|
# @!attribute [rw] description
|
316
|
-
#
|
352
|
+
# A human-readable description of the alias.
|
317
353
|
# @return [String]
|
318
354
|
#
|
319
355
|
# @!attribute [rw] routing_strategy
|
320
|
-
#
|
321
|
-
# alias.
|
356
|
+
# The routing configuration, including routing type and fleet target,
|
357
|
+
# for the alias.
|
322
358
|
# @return [Types::RoutingStrategy]
|
323
359
|
#
|
360
|
+
# @!attribute [rw] tags
|
361
|
+
# A list of labels to assign to the new alias resource. Tags are
|
362
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
363
|
+
# for resource management, access management and cost allocation. For
|
364
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS
|
365
|
+
# General Reference*. Once the resource is created, you can use
|
366
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
367
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
368
|
+
# the AWS General Reference for actual tagging limits.
|
369
|
+
#
|
370
|
+
#
|
371
|
+
#
|
372
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
373
|
+
# @return [Array<Types::Tag>]
|
374
|
+
#
|
324
375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateAliasInput AWS API Documentation
|
325
376
|
#
|
326
377
|
class CreateAliasInput < Struct.new(
|
327
378
|
:name,
|
328
379
|
:description,
|
329
|
-
:routing_strategy
|
380
|
+
:routing_strategy,
|
381
|
+
:tags)
|
330
382
|
include Aws::Structure
|
331
383
|
end
|
332
384
|
|
333
385
|
# Represents the returned data in response to a request action.
|
334
386
|
#
|
335
387
|
# @!attribute [rw] alias
|
336
|
-
#
|
388
|
+
# The newly created alias resource.
|
337
389
|
# @return [Types::Alias]
|
338
390
|
#
|
339
391
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateAliasOutput AWS API Documentation
|
@@ -358,54 +410,76 @@ module Aws::GameLift
|
|
358
410
|
# object_version: "NonEmptyString",
|
359
411
|
# },
|
360
412
|
# operating_system: "WINDOWS_2012", # accepts WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2
|
413
|
+
# tags: [
|
414
|
+
# {
|
415
|
+
# key: "TagKey", # required
|
416
|
+
# value: "TagValue", # required
|
417
|
+
# },
|
418
|
+
# ],
|
361
419
|
# }
|
362
420
|
#
|
363
421
|
# @!attribute [rw] name
|
364
|
-
#
|
422
|
+
# A descriptive label that is associated with a build. Build names do
|
365
423
|
# not need to be unique. You can use UpdateBuild to change this value
|
366
424
|
# later.
|
367
425
|
# @return [String]
|
368
426
|
#
|
369
427
|
# @!attribute [rw] version
|
370
|
-
# Version that is associated with a build or script.
|
371
|
-
# do not need to be unique. You can use UpdateBuild to
|
372
|
-
# value later.
|
428
|
+
# Version information that is associated with a build or script.
|
429
|
+
# Version strings do not need to be unique. You can use UpdateBuild to
|
430
|
+
# change this value later.
|
373
431
|
# @return [String]
|
374
432
|
#
|
375
433
|
# @!attribute [rw] storage_location
|
376
434
|
# Information indicating where your game build files are stored. Use
|
377
435
|
# this parameter only when creating a build with files stored in an
|
378
436
|
# Amazon S3 bucket that you own. The storage location must specify an
|
379
|
-
# Amazon S3 bucket name and key
|
380
|
-
# you set up to allow Amazon GameLift to access your Amazon
|
381
|
-
# The S3 bucket must be in the same
|
382
|
-
#
|
437
|
+
# Amazon S3 bucket name and key. The location must also specify a role
|
438
|
+
# ARN that you set up to allow Amazon GameLift to access your Amazon
|
439
|
+
# S3 bucket. The S3 bucket and your new build must be in the same
|
440
|
+
# Region.
|
383
441
|
# @return [Types::S3Location]
|
384
442
|
#
|
385
443
|
# @!attribute [rw] operating_system
|
386
|
-
#
|
387
|
-
# This value determines the type of fleet resources that you can
|
388
|
-
# for this build. If your game build contains multiple
|
389
|
-
# they all must run on the same operating system. If an
|
390
|
-
# system is not specified when creating a build, Amazon
|
391
|
-
# the default value (WINDOWS\_2012). This value cannot
|
392
|
-
# later.
|
444
|
+
# The operating system that the game server binaries are built to run
|
445
|
+
# on. This value determines the type of fleet resources that you can
|
446
|
+
# use for this build. If your game build contains multiple
|
447
|
+
# executables, they all must run on the same operating system. If an
|
448
|
+
# operating system is not specified when creating a build, Amazon
|
449
|
+
# GameLift uses the default value (WINDOWS\_2012). This value cannot
|
450
|
+
# be changed later.
|
393
451
|
# @return [String]
|
394
452
|
#
|
453
|
+
# @!attribute [rw] tags
|
454
|
+
# A list of labels to assign to the new build resource. Tags are
|
455
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
456
|
+
# for resource management, access management and cost allocation. For
|
457
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS
|
458
|
+
# General Reference*. Once the resource is created, you can use
|
459
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
460
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
461
|
+
# the AWS General Reference for actual tagging limits.
|
462
|
+
#
|
463
|
+
#
|
464
|
+
#
|
465
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
466
|
+
# @return [Array<Types::Tag>]
|
467
|
+
#
|
395
468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateBuildInput AWS API Documentation
|
396
469
|
#
|
397
470
|
class CreateBuildInput < Struct.new(
|
398
471
|
:name,
|
399
472
|
:version,
|
400
473
|
:storage_location,
|
401
|
-
:operating_system
|
474
|
+
:operating_system,
|
475
|
+
:tags)
|
402
476
|
include Aws::Structure
|
403
477
|
end
|
404
478
|
|
405
479
|
# Represents the returned data in response to a request action.
|
406
480
|
#
|
407
481
|
# @!attribute [rw] build
|
408
|
-
# The newly created build record, including a unique build
|
482
|
+
# The newly created build record, including a unique build IDs and
|
409
483
|
# status.
|
410
484
|
# @return [Types::Build]
|
411
485
|
#
|
@@ -477,43 +551,50 @@ module Aws::GameLift
|
|
477
551
|
# certificate_configuration: {
|
478
552
|
# certificate_type: "DISABLED", # required, accepts DISABLED, GENERATED
|
479
553
|
# },
|
554
|
+
# tags: [
|
555
|
+
# {
|
556
|
+
# key: "TagKey", # required
|
557
|
+
# value: "TagValue", # required
|
558
|
+
# },
|
559
|
+
# ],
|
480
560
|
# }
|
481
561
|
#
|
482
562
|
# @!attribute [rw] name
|
483
|
-
#
|
563
|
+
# A descriptive label that is associated with a fleet. Fleet names do
|
484
564
|
# not need to be unique.
|
485
565
|
# @return [String]
|
486
566
|
#
|
487
567
|
# @!attribute [rw] description
|
488
|
-
#
|
568
|
+
# A human-readable description of a fleet.
|
489
569
|
# @return [String]
|
490
570
|
#
|
491
571
|
# @!attribute [rw] build_id
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
# cannot be changed once the
|
572
|
+
# A unique identifier for a build to be deployed on the new fleet. You
|
573
|
+
# can use either the build ID or ARN value. The custom game server
|
574
|
+
# build must have been successfully uploaded to Amazon GameLift and be
|
575
|
+
# in a `READY` status. This fleet setting cannot be changed once the
|
576
|
+
# fleet is created.
|
496
577
|
# @return [String]
|
497
578
|
#
|
498
579
|
# @!attribute [rw] script_id
|
499
|
-
#
|
500
|
-
# fleet.
|
501
|
-
#
|
502
|
-
# is created.
|
580
|
+
# A unique identifier for a Realtime script to be deployed on the new
|
581
|
+
# fleet. You can use either the script ID or ARN value. The Realtime
|
582
|
+
# script must have been successfully uploaded to Amazon GameLift. This
|
583
|
+
# fleet setting cannot be changed once the fleet is created.
|
503
584
|
# @return [String]
|
504
585
|
#
|
505
586
|
# @!attribute [rw] server_launch_path
|
506
587
|
# This parameter is no longer used. Instead, specify a server launch
|
507
|
-
# path using the `RuntimeConfiguration` parameter.
|
588
|
+
# path using the `RuntimeConfiguration` parameter. Requests that
|
508
589
|
# specify a server launch path and launch parameters instead of a
|
509
|
-
#
|
590
|
+
# runtime configuration will continue to work.
|
510
591
|
# @return [String]
|
511
592
|
#
|
512
593
|
# @!attribute [rw] server_launch_parameters
|
513
594
|
# This parameter is no longer used. Instead, specify server launch
|
514
595
|
# parameters in the `RuntimeConfiguration` parameter. (Requests that
|
515
596
|
# specify a server launch path and launch parameters instead of a
|
516
|
-
#
|
597
|
+
# runtime configuration will continue to work.)
|
517
598
|
# @return [String]
|
518
599
|
#
|
519
600
|
# @!attribute [rw] log_paths
|
@@ -529,9 +610,9 @@ module Aws::GameLift
|
|
529
610
|
# @return [Array<String>]
|
530
611
|
#
|
531
612
|
# @!attribute [rw] ec2_instance_type
|
532
|
-
#
|
533
|
-
# fleet instance type determines the computing resources
|
534
|
-
# instance in the fleet, including CPU, memory, storage, and
|
613
|
+
# The name of an EC2 instance type that is supported in Amazon
|
614
|
+
# GameLift. A fleet instance type determines the computing resources
|
615
|
+
# of each instance in the fleet, including CPU, memory, storage, and
|
535
616
|
# networking capacity. Amazon GameLift supports the following EC2
|
536
617
|
# instance types. See [Amazon EC2 Instance Types][1] for detailed
|
537
618
|
# descriptions.
|
@@ -543,66 +624,71 @@ module Aws::GameLift
|
|
543
624
|
#
|
544
625
|
# @!attribute [rw] ec2_inbound_permissions
|
545
626
|
# Range of IP addresses and port settings that permit inbound traffic
|
546
|
-
# to access game sessions that running on the fleet. For fleets
|
547
|
-
# a custom game build, this parameter is required before game
|
548
|
-
# running on the fleet can accept connections. For Realtime
|
549
|
-
# fleets, Amazon GameLift automatically sets TCP and UDP
|
550
|
-
# use by the Realtime servers. You can specify multiple
|
551
|
-
# settings or add more by updating the fleet.
|
627
|
+
# to access game sessions that are running on the fleet. For fleets
|
628
|
+
# using a custom game build, this parameter is required before game
|
629
|
+
# sessions running on the fleet can accept connections. For Realtime
|
630
|
+
# Servers fleets, Amazon GameLift automatically sets TCP and UDP
|
631
|
+
# ranges for use by the Realtime servers. You can specify multiple
|
632
|
+
# permission settings or add more by updating the fleet.
|
552
633
|
# @return [Array<Types::IpPermission>]
|
553
634
|
#
|
554
635
|
# @!attribute [rw] new_game_session_protection_policy
|
555
|
-
#
|
636
|
+
# A game session protection policy to apply to all instances in this
|
556
637
|
# fleet. If this parameter is not set, instances in this fleet default
|
557
638
|
# to no protection. You can change a fleet's protection policy using
|
558
639
|
# UpdateFleetAttributes, but this change will only affect sessions
|
559
640
|
# created after the policy change. You can also set protection for
|
560
641
|
# individual instances using UpdateGameSession.
|
561
642
|
#
|
562
|
-
# * **NoProtection**
|
643
|
+
# * **NoProtection** - The game session can be terminated during a
|
563
644
|
# scale-down event.
|
564
645
|
#
|
565
|
-
# * **FullProtection**
|
566
|
-
#
|
646
|
+
# * **FullProtection** - If the game session is in an `ACTIVE` status,
|
647
|
+
# it cannot be terminated during a scale-down event.
|
567
648
|
# @return [String]
|
568
649
|
#
|
569
650
|
# @!attribute [rw] runtime_configuration
|
570
651
|
# Instructions for launching server processes on each instance in the
|
571
652
|
# fleet. Server processes run either a custom game build executable or
|
572
|
-
# a Realtime
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
653
|
+
# a Realtime script. The runtime configuration defines the server
|
654
|
+
# executables or launch script file, launch parameters, and the number
|
655
|
+
# of processes to run concurrently on each instance. When creating a
|
656
|
+
# fleet, the runtime configuration must have at least one server
|
657
|
+
# process configuration; otherwise the request fails with an invalid
|
658
|
+
# request exception. (This parameter replaces the parameters
|
659
|
+
# `ServerLaunchPath` and `ServerLaunchParameters`, although requests
|
660
|
+
# that contain values for these parameters instead of a runtime
|
661
|
+
# configuration will continue to work.) This parameter is required
|
662
|
+
# unless the parameters `ServerLaunchPath` and
|
663
|
+
# `ServerLaunchParameters` are defined. Runtime configuration replaced
|
664
|
+
# these parameters, but fleets that use them will continue to work.
|
579
665
|
# @return [Types::RuntimeConfiguration]
|
580
666
|
#
|
581
667
|
# @!attribute [rw] resource_creation_limit_policy
|
582
|
-
#
|
583
|
-
# can create over a span of time for this fleet.
|
668
|
+
# A policy that limits the number of game sessions an individual
|
669
|
+
# player can create over a span of time for this fleet.
|
584
670
|
# @return [Types::ResourceCreationLimitPolicy]
|
585
671
|
#
|
586
672
|
# @!attribute [rw] metric_groups
|
587
|
-
#
|
588
|
-
# metric group aggregates the metrics for all fleets in the group.
|
673
|
+
# The name of an Amazon CloudWatch metric group to add this fleet to.
|
674
|
+
# A metric group aggregates the metrics for all fleets in the group.
|
589
675
|
# Specify an existing metric group name, or provide a new name to
|
590
676
|
# create a new metric group. A fleet can only be included in one
|
591
677
|
# metric group at a time.
|
592
678
|
# @return [Array<String>]
|
593
679
|
#
|
594
680
|
# @!attribute [rw] peer_vpc_aws_account_id
|
595
|
-
#
|
596
|
-
# peer your Amazon GameLift fleet with. You can find your
|
597
|
-
# in the AWS Management Console under account settings.
|
681
|
+
# A unique identifier for the AWS account with the VPC that you want
|
682
|
+
# to peer your Amazon GameLift fleet with. You can find your account
|
683
|
+
# ID in the AWS Management Console under account settings.
|
598
684
|
# @return [String]
|
599
685
|
#
|
600
686
|
# @!attribute [rw] peer_vpc_id
|
601
|
-
#
|
602
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
603
|
-
# fleet
|
604
|
-
#
|
605
|
-
#
|
687
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
688
|
+
# Amazon GameLift fleet. The VPC must be in the same Region as your
|
689
|
+
# fleet. To look up a VPC ID, use the [VPC Dashboard][1] in the AWS
|
690
|
+
# Management Console. Learn more about VPC peering in [VPC Peering
|
691
|
+
# with Amazon GameLift Fleets][2].
|
606
692
|
#
|
607
693
|
#
|
608
694
|
#
|
@@ -611,8 +697,8 @@ module Aws::GameLift
|
|
611
697
|
# @return [String]
|
612
698
|
#
|
613
699
|
# @!attribute [rw] fleet_type
|
614
|
-
# Indicates whether to use
|
615
|
-
# this fleet. If empty, the default is
|
700
|
+
# Indicates whether to use On-Demand instances or Spot instances for
|
701
|
+
# this fleet. If empty, the default is `ON_DEMAND`. Both categories of
|
616
702
|
# instances use identical hardware and configurations based on the
|
617
703
|
# instance type selected for this fleet. Learn more about [ On-Demand
|
618
704
|
# versus Spot Instances][1].
|
@@ -623,14 +709,14 @@ module Aws::GameLift
|
|
623
709
|
# @return [String]
|
624
710
|
#
|
625
711
|
# @!attribute [rw] instance_role_arn
|
626
|
-
#
|
712
|
+
# A unique identifier for an AWS IAM role that manages access to your
|
627
713
|
# AWS services. With an instance role ARN set, any application that
|
628
714
|
# runs on an instance in this fleet can assume the role, including
|
629
|
-
# install scripts, server processes, daemons (background
|
630
|
-
# Create a role or look up a role's ARN
|
631
|
-
# in the AWS Management Console. Learn more about using
|
632
|
-
# credentials for your game servers at [ Access external
|
633
|
-
# from a game server][2].
|
715
|
+
# install scripts, server processes, and daemons (background
|
716
|
+
# processes). Create a role or look up a role's ARN from the [IAM
|
717
|
+
# dashboard][1] in the AWS Management Console. Learn more about using
|
718
|
+
# on-box credentials for your game servers at [ Access external
|
719
|
+
# resources from a game server][2].
|
634
720
|
#
|
635
721
|
#
|
636
722
|
#
|
@@ -639,8 +725,46 @@ module Aws::GameLift
|
|
639
725
|
# @return [String]
|
640
726
|
#
|
641
727
|
# @!attribute [rw] certificate_configuration
|
728
|
+
# Indicates whether to generate a TLS/SSL certificate for the new
|
729
|
+
# fleet. TLS certificates are used for encrypting traffic between game
|
730
|
+
# clients and game servers running on GameLift. If this parameter is
|
731
|
+
# not specified, the default value, DISABLED, is used. This fleet
|
732
|
+
# setting cannot be changed once the fleet is created. Learn more at
|
733
|
+
# [Securing Client/Server Communication][1].
|
734
|
+
#
|
735
|
+
# Note: This feature requires the AWS Certificate Manager (ACM)
|
736
|
+
# service, which is available in the AWS global partition but not in
|
737
|
+
# all other partitions. When working in a partition that does not
|
738
|
+
# support this feature, a request for a new fleet with certificate
|
739
|
+
# generation results fails with a 4xx unsupported Region error.
|
740
|
+
#
|
741
|
+
# Valid values include:
|
742
|
+
#
|
743
|
+
# * **GENERATED** - Generate a TLS/SSL certificate for this fleet.
|
744
|
+
#
|
745
|
+
# * **DISABLED** - (default) Do not generate a TLS/SSL certificate for
|
746
|
+
# this fleet.
|
747
|
+
#
|
748
|
+
#
|
749
|
+
#
|
750
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security
|
642
751
|
# @return [Types::CertificateConfiguration]
|
643
752
|
#
|
753
|
+
# @!attribute [rw] tags
|
754
|
+
# A list of labels to assign to the new fleet resource. Tags are
|
755
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
756
|
+
# for resource management, access management and cost allocation. For
|
757
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS
|
758
|
+
# General Reference*. Once the resource is created, you can use
|
759
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
760
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
761
|
+
# the AWS General Reference for actual tagging limits.
|
762
|
+
#
|
763
|
+
#
|
764
|
+
#
|
765
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
766
|
+
# @return [Array<Types::Tag>]
|
767
|
+
#
|
644
768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetInput AWS API Documentation
|
645
769
|
#
|
646
770
|
class CreateFleetInput < Struct.new(
|
@@ -661,7 +785,8 @@ module Aws::GameLift
|
|
661
785
|
:peer_vpc_id,
|
662
786
|
:fleet_type,
|
663
787
|
:instance_role_arn,
|
664
|
-
:certificate_configuration
|
788
|
+
:certificate_configuration,
|
789
|
+
:tags)
|
665
790
|
include Aws::Structure
|
666
791
|
end
|
667
792
|
|
@@ -701,23 +826,25 @@ module Aws::GameLift
|
|
701
826
|
# }
|
702
827
|
#
|
703
828
|
# @!attribute [rw] fleet_id
|
704
|
-
#
|
705
|
-
#
|
829
|
+
# A unique identifier for a fleet to create a game session in. You can
|
830
|
+
# use either the fleet ID or ARN value. Each request must reference
|
831
|
+
# either a fleet ID or alias ID, but not both.
|
706
832
|
# @return [String]
|
707
833
|
#
|
708
834
|
# @!attribute [rw] alias_id
|
709
|
-
#
|
710
|
-
# game session in.
|
711
|
-
# alias ID, but not
|
835
|
+
# A unique identifier for an alias associated with the fleet to create
|
836
|
+
# a game session in. You can use either the alias ID or ARN value.
|
837
|
+
# Each request must reference either a fleet ID or alias ID, but not
|
838
|
+
# both.
|
712
839
|
# @return [String]
|
713
840
|
#
|
714
841
|
# @!attribute [rw] maximum_player_session_count
|
715
|
-
#
|
716
|
-
# the game session.
|
842
|
+
# The maximum number of players that can be connected simultaneously
|
843
|
+
# to the game session.
|
717
844
|
# @return [Integer]
|
718
845
|
#
|
719
846
|
# @!attribute [rw] name
|
720
|
-
#
|
847
|
+
# A descriptive label that is associated with a game session. Session
|
721
848
|
# names do not need to be unique.
|
722
849
|
# @return [String]
|
723
850
|
#
|
@@ -733,10 +860,10 @@ module Aws::GameLift
|
|
733
860
|
# @return [Array<Types::GameProperty>]
|
734
861
|
#
|
735
862
|
# @!attribute [rw] creator_id
|
736
|
-
#
|
737
|
-
# This ID is used to enforce a resource protection policy (if
|
738
|
-
# exists) that limits the number of concurrent active game
|
739
|
-
# one player can have.
|
863
|
+
# A unique identifier for a player or entity creating the game
|
864
|
+
# session. This ID is used to enforce a resource protection policy (if
|
865
|
+
# one exists) that limits the number of concurrent active game
|
866
|
+
# sessions one player can have.
|
740
867
|
# @return [String]
|
741
868
|
#
|
742
869
|
# @!attribute [rw] game_session_id
|
@@ -818,55 +945,77 @@ module Aws::GameLift
|
|
818
945
|
# destination_arn: "ArnStringModel",
|
819
946
|
# },
|
820
947
|
# ],
|
948
|
+
# tags: [
|
949
|
+
# {
|
950
|
+
# key: "TagKey", # required
|
951
|
+
# value: "TagValue", # required
|
952
|
+
# },
|
953
|
+
# ],
|
821
954
|
# }
|
822
955
|
#
|
823
956
|
# @!attribute [rw] name
|
824
|
-
#
|
825
|
-
# names must be unique within each
|
957
|
+
# A descriptive label that is associated with game session queue.
|
958
|
+
# Queue names must be unique within each Region.
|
826
959
|
# @return [String]
|
827
960
|
#
|
828
961
|
# @!attribute [rw] timeout_in_seconds
|
829
|
-
#
|
830
|
-
# remains in the queue. When a request exceeds this time, the
|
831
|
-
# session placement changes to a `TIMED_OUT` status.
|
962
|
+
# The maximum time, in seconds, that a new game session placement
|
963
|
+
# request remains in the queue. When a request exceeds this time, the
|
964
|
+
# game session placement changes to a `TIMED_OUT` status.
|
832
965
|
# @return [Integer]
|
833
966
|
#
|
834
967
|
# @!attribute [rw] player_latency_policies
|
835
|
-
#
|
968
|
+
# A collection of latency policies to apply when processing game
|
836
969
|
# sessions placement requests with player latency information.
|
837
970
|
# Multiple policies are evaluated in order of the maximum latency
|
838
971
|
# value, starting with the lowest latency values. With just one
|
839
|
-
# policy,
|
840
|
-
# for the duration period. With multiple policies, each
|
841
|
-
# enforced consecutively for its duration period. For
|
842
|
-
# might enforce a 60-second policy followed by a
|
843
|
-
# and then no policy for the remainder of the
|
844
|
-
# latency policy must set a value for
|
845
|
-
# MaximumIndividualPlayerLatencyMilliseconds
|
846
|
-
#
|
972
|
+
# policy, the policy is enforced at the start of the game session
|
973
|
+
# placement for the duration period. With multiple policies, each
|
974
|
+
# policy is enforced consecutively for its duration period. For
|
975
|
+
# example, a queue might enforce a 60-second policy followed by a
|
976
|
+
# 120-second policy, and then no policy for the remainder of the
|
977
|
+
# placement. A player latency policy must set a value for
|
978
|
+
# `MaximumIndividualPlayerLatencyMilliseconds`. If none is set, this
|
979
|
+
# API request fails.
|
847
980
|
# @return [Array<Types::PlayerLatencyPolicy>]
|
848
981
|
#
|
849
982
|
# @!attribute [rw] destinations
|
850
|
-
#
|
983
|
+
# A list of fleets that can be used to fulfill game session placement
|
851
984
|
# requests in the queue. Fleets are identified by either a fleet ARN
|
852
985
|
# or a fleet alias ARN. Destinations are listed in default preference
|
853
986
|
# order.
|
854
987
|
# @return [Array<Types::GameSessionQueueDestination>]
|
855
988
|
#
|
989
|
+
# @!attribute [rw] tags
|
990
|
+
# A list of labels to assign to the new game session queue resource.
|
991
|
+
# Tags are developer-defined key-value pairs. Tagging AWS resources
|
992
|
+
# are useful for resource management, access management and cost
|
993
|
+
# allocation. For more information, see [ Tagging AWS Resources][1] in
|
994
|
+
# the *AWS General Reference*. Once the resource is created, you can
|
995
|
+
# use TagResource, UntagResource, and ListTagsForResource to add,
|
996
|
+
# remove, and view tags. The maximum tag limit may be lower than
|
997
|
+
# stated. See the AWS General Reference for actual tagging limits.
|
998
|
+
#
|
999
|
+
#
|
1000
|
+
#
|
1001
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1002
|
+
# @return [Array<Types::Tag>]
|
1003
|
+
#
|
856
1004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionQueueInput AWS API Documentation
|
857
1005
|
#
|
858
1006
|
class CreateGameSessionQueueInput < Struct.new(
|
859
1007
|
:name,
|
860
1008
|
:timeout_in_seconds,
|
861
1009
|
:player_latency_policies,
|
862
|
-
:destinations
|
1010
|
+
:destinations,
|
1011
|
+
:tags)
|
863
1012
|
include Aws::Structure
|
864
1013
|
end
|
865
1014
|
|
866
1015
|
# Represents the returned data in response to a request action.
|
867
1016
|
#
|
868
1017
|
# @!attribute [rw] game_session_queue
|
869
|
-
#
|
1018
|
+
# An object that describes the newly created game session queue.
|
870
1019
|
# @return [Types::GameSessionQueue]
|
871
1020
|
#
|
872
1021
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionQueueOutput AWS API Documentation
|
@@ -888,7 +1037,7 @@ module Aws::GameLift
|
|
888
1037
|
# request_timeout_seconds: 1, # required
|
889
1038
|
# acceptance_timeout_seconds: 1,
|
890
1039
|
# acceptance_required: false, # required
|
891
|
-
# rule_set_name: "
|
1040
|
+
# rule_set_name: "MatchmakingRuleSetName", # required
|
892
1041
|
# notification_target: "SnsArnStringModel",
|
893
1042
|
# additional_player_count: 1,
|
894
1043
|
# custom_event_data: "CustomEventData",
|
@@ -900,64 +1049,73 @@ module Aws::GameLift
|
|
900
1049
|
# ],
|
901
1050
|
# game_session_data: "GameSessionData",
|
902
1051
|
# backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
|
1052
|
+
# tags: [
|
1053
|
+
# {
|
1054
|
+
# key: "TagKey", # required
|
1055
|
+
# value: "TagValue", # required
|
1056
|
+
# },
|
1057
|
+
# ],
|
903
1058
|
# }
|
904
1059
|
#
|
905
1060
|
# @!attribute [rw] name
|
906
|
-
#
|
907
|
-
# to identify the configuration associated with a matchmaking
|
908
|
-
# or ticket.
|
1061
|
+
# A unique identifier for a matchmaking configuration. This name is
|
1062
|
+
# used to identify the configuration associated with a matchmaking
|
1063
|
+
# request or ticket.
|
909
1064
|
# @return [String]
|
910
1065
|
#
|
911
1066
|
# @!attribute [rw] description
|
912
|
-
#
|
1067
|
+
# A human-readable description of the matchmaking configuration.
|
913
1068
|
# @return [String]
|
914
1069
|
#
|
915
1070
|
# @!attribute [rw] game_session_queue_arns
|
916
|
-
# Amazon Resource Name ([ARN][1]) that is assigned to a game
|
917
|
-
# queue and uniquely identifies it.
|
918
|
-
#
|
919
|
-
#
|
920
|
-
#
|
921
|
-
# located in any region.
|
1071
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
1072
|
+
# session queue resource and uniquely identifies it. ARNs are unique
|
1073
|
+
# across all Regions. These queues are used when placing game sessions
|
1074
|
+
# for matches that are created with this matchmaking configuration.
|
1075
|
+
# Queues can be located in any Region.
|
922
1076
|
#
|
923
1077
|
#
|
924
1078
|
#
|
925
|
-
# [1]: https://docs.aws.amazon.com/
|
1079
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
926
1080
|
# @return [Array<String>]
|
927
1081
|
#
|
928
1082
|
# @!attribute [rw] request_timeout_seconds
|
929
|
-
#
|
930
|
-
# in process before timing out. Requests that fail due to
|
931
|
-
# can be resubmitted as needed.
|
1083
|
+
# The maximum duration, in seconds, that a matchmaking ticket can
|
1084
|
+
# remain in process before timing out. Requests that fail due to
|
1085
|
+
# timing out can be resubmitted as needed.
|
932
1086
|
# @return [Integer]
|
933
1087
|
#
|
934
1088
|
# @!attribute [rw] acceptance_timeout_seconds
|
935
|
-
#
|
936
|
-
# match. If any player rejects the match or fails to accept
|
937
|
-
# timeout, the ticket continues to look for an acceptable
|
1089
|
+
# The length of time (in seconds) to wait for players to accept a
|
1090
|
+
# proposed match. If any player rejects the match or fails to accept
|
1091
|
+
# before the timeout, the ticket continues to look for an acceptable
|
1092
|
+
# match.
|
938
1093
|
# @return [Integer]
|
939
1094
|
#
|
940
1095
|
# @!attribute [rw] acceptance_required
|
941
|
-
#
|
1096
|
+
# A flag that determines whether a match that was created with this
|
942
1097
|
# configuration must be accepted by the matched players. To require
|
943
|
-
# acceptance, set to TRUE
|
1098
|
+
# acceptance, set to `TRUE`.
|
944
1099
|
# @return [Boolean]
|
945
1100
|
#
|
946
1101
|
# @!attribute [rw] rule_set_name
|
947
|
-
#
|
948
|
-
# configuration.
|
949
|
-
# that are defined in
|
1102
|
+
# A unique identifier for a matchmaking rule set to use with this
|
1103
|
+
# configuration. You can use either the rule set name or ARN value. A
|
1104
|
+
# matchmaking configuration can only use rule sets that are defined in
|
1105
|
+
# the same Region.
|
950
1106
|
# @return [String]
|
951
1107
|
#
|
952
1108
|
# @!attribute [rw] notification_target
|
953
|
-
# SNS topic ARN that is set up to receive matchmaking
|
1109
|
+
# An SNS topic ARN that is set up to receive matchmaking
|
1110
|
+
# notifications.
|
954
1111
|
# @return [String]
|
955
1112
|
#
|
956
1113
|
# @!attribute [rw] additional_player_count
|
957
|
-
#
|
958
|
-
# For example,
|
959
|
-
# a single 12-person team
|
960
|
-
# 2, only 10 players are selected for
|
1114
|
+
# The number of player slots in a match to keep open for future
|
1115
|
+
# players. For example, assume that the configuration's rule set
|
1116
|
+
# specifies a match for a single 12-person team. If the additional
|
1117
|
+
# player count is set to 2, only 10 players are initially selected for
|
1118
|
+
# the match.
|
961
1119
|
# @return [Integer]
|
962
1120
|
#
|
963
1121
|
# @!attribute [rw] custom_event_data
|
@@ -966,11 +1124,12 @@ module Aws::GameLift
|
|
966
1124
|
# @return [String]
|
967
1125
|
#
|
968
1126
|
# @!attribute [rw] game_properties
|
969
|
-
#
|
970
|
-
# pairs. These properties are passed to a game server
|
971
|
-
# GameSession object with a request to start a new game
|
972
|
-
# [Start a Game Session][1]). This information is added
|
973
|
-
# GameSession object that is created for a successful
|
1127
|
+
# A set of custom properties for a game session, formatted as
|
1128
|
+
# key-value pairs. These properties are passed to a game server
|
1129
|
+
# process in the GameSession object with a request to start a new game
|
1130
|
+
# session (see [Start a Game Session][1]). This information is added
|
1131
|
+
# to the new GameSession object that is created for a successful
|
1132
|
+
# match.
|
974
1133
|
#
|
975
1134
|
#
|
976
1135
|
#
|
@@ -978,8 +1137,8 @@ module Aws::GameLift
|
|
978
1137
|
# @return [Array<Types::GameProperty>]
|
979
1138
|
#
|
980
1139
|
# @!attribute [rw] game_session_data
|
981
|
-
#
|
982
|
-
# value. This data is passed to a game server process in the
|
1140
|
+
# A set of custom game session properties, formatted as a single
|
1141
|
+
# string value. This data is passed to a game server process in the
|
983
1142
|
# GameSession object with a request to start a new game session (see
|
984
1143
|
# [Start a Game Session][1]). This information is added to the new
|
985
1144
|
# GameSession object that is created for a successful match.
|
@@ -990,19 +1149,35 @@ module Aws::GameLift
|
|
990
1149
|
# @return [String]
|
991
1150
|
#
|
992
1151
|
# @!attribute [rw] backfill_mode
|
993
|
-
#
|
994
|
-
# configuration. Specify MANUAL when your game manages
|
995
|
-
# requests manually or does not use the match backfill
|
996
|
-
# Specify AUTOMATIC to have GameLift create a
|
997
|
-
# request whenever a game session has one or more
|
998
|
-
# more about manual and automatic backfill in [
|
999
|
-
# Games with FlexMatch][1].
|
1152
|
+
# The method used to backfill game sessions that are created with this
|
1153
|
+
# matchmaking configuration. Specify `MANUAL` when your game manages
|
1154
|
+
# backfill requests manually or does not use the match backfill
|
1155
|
+
# feature. Specify `AUTOMATIC` to have GameLift create a
|
1156
|
+
# StartMatchBackfill request whenever a game session has one or more
|
1157
|
+
# open slots. Learn more about manual and automatic backfill in [
|
1158
|
+
# Backfill Existing Games with FlexMatch][1].
|
1000
1159
|
#
|
1001
1160
|
#
|
1002
1161
|
#
|
1003
1162
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html
|
1004
1163
|
# @return [String]
|
1005
1164
|
#
|
1165
|
+
# @!attribute [rw] tags
|
1166
|
+
# A list of labels to assign to the new matchmaking configuration
|
1167
|
+
# resource. Tags are developer-defined key-value pairs. Tagging AWS
|
1168
|
+
# resources are useful for resource management, access management and
|
1169
|
+
# cost allocation. For more information, see [ Tagging AWS
|
1170
|
+
# Resources][1] in the *AWS General Reference*. Once the resource is
|
1171
|
+
# created, you can use TagResource, UntagResource, and
|
1172
|
+
# ListTagsForResource to add, remove, and view tags. The maximum tag
|
1173
|
+
# limit may be lower than stated. See the AWS General Reference for
|
1174
|
+
# actual tagging limits.
|
1175
|
+
#
|
1176
|
+
#
|
1177
|
+
#
|
1178
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1179
|
+
# @return [Array<Types::Tag>]
|
1180
|
+
#
|
1006
1181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfigurationInput AWS API Documentation
|
1007
1182
|
#
|
1008
1183
|
class CreateMatchmakingConfigurationInput < Struct.new(
|
@@ -1018,7 +1193,8 @@ module Aws::GameLift
|
|
1018
1193
|
:custom_event_data,
|
1019
1194
|
:game_properties,
|
1020
1195
|
:game_session_data,
|
1021
|
-
:backfill_mode
|
1196
|
+
:backfill_mode,
|
1197
|
+
:tags)
|
1022
1198
|
include Aws::Structure
|
1023
1199
|
end
|
1024
1200
|
|
@@ -1043,33 +1219,55 @@ module Aws::GameLift
|
|
1043
1219
|
# {
|
1044
1220
|
# name: "MatchmakingIdStringModel", # required
|
1045
1221
|
# rule_set_body: "RuleSetBody", # required
|
1222
|
+
# tags: [
|
1223
|
+
# {
|
1224
|
+
# key: "TagKey", # required
|
1225
|
+
# value: "TagValue", # required
|
1226
|
+
# },
|
1227
|
+
# ],
|
1046
1228
|
# }
|
1047
1229
|
#
|
1048
1230
|
# @!attribute [rw] name
|
1049
|
-
#
|
1231
|
+
# A unique identifier for a matchmaking rule set. A matchmaking
|
1050
1232
|
# configuration identifies the rule set it uses by this name value.
|
1051
|
-
#
|
1052
|
-
# field in the rule set body.
|
1233
|
+
# Note that the rule set name is different from the optional `name`
|
1234
|
+
# field in the rule set body.
|
1053
1235
|
# @return [String]
|
1054
1236
|
#
|
1055
1237
|
# @!attribute [rw] rule_set_body
|
1056
|
-
#
|
1238
|
+
# A collection of matchmaking rules, formatted as a JSON string.
|
1057
1239
|
# Comments are not allowed in JSON, but most elements support a
|
1058
1240
|
# description field.
|
1059
1241
|
# @return [String]
|
1060
1242
|
#
|
1243
|
+
# @!attribute [rw] tags
|
1244
|
+
# A list of labels to assign to the new matchmaking rule set resource.
|
1245
|
+
# Tags are developer-defined key-value pairs. Tagging AWS resources
|
1246
|
+
# are useful for resource management, access management and cost
|
1247
|
+
# allocation. For more information, see [ Tagging AWS Resources][1] in
|
1248
|
+
# the *AWS General Reference*. Once the resource is created, you can
|
1249
|
+
# use TagResource, UntagResource, and ListTagsForResource to add,
|
1250
|
+
# remove, and view tags. The maximum tag limit may be lower than
|
1251
|
+
# stated. See the AWS General Reference for actual tagging limits.
|
1252
|
+
#
|
1253
|
+
#
|
1254
|
+
#
|
1255
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1256
|
+
# @return [Array<Types::Tag>]
|
1257
|
+
#
|
1061
1258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingRuleSetInput AWS API Documentation
|
1062
1259
|
#
|
1063
1260
|
class CreateMatchmakingRuleSetInput < Struct.new(
|
1064
1261
|
:name,
|
1065
|
-
:rule_set_body
|
1262
|
+
:rule_set_body,
|
1263
|
+
:tags)
|
1066
1264
|
include Aws::Structure
|
1067
1265
|
end
|
1068
1266
|
|
1069
1267
|
# Represents the returned data in response to a request action.
|
1070
1268
|
#
|
1071
1269
|
# @!attribute [rw] rule_set
|
1072
|
-
#
|
1270
|
+
# The newly created matchmaking rule set.
|
1073
1271
|
# @return [Types::MatchmakingRuleSet]
|
1074
1272
|
#
|
1075
1273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingRuleSetOutput AWS API Documentation
|
@@ -1091,11 +1289,11 @@ module Aws::GameLift
|
|
1091
1289
|
# }
|
1092
1290
|
#
|
1093
1291
|
# @!attribute [rw] game_session_id
|
1094
|
-
#
|
1292
|
+
# A unique identifier for the game session to add a player to.
|
1095
1293
|
# @return [String]
|
1096
1294
|
#
|
1097
1295
|
# @!attribute [rw] player_id
|
1098
|
-
#
|
1296
|
+
# A unique identifier for a player. Player IDs are developer-defined.
|
1099
1297
|
# @return [String]
|
1100
1298
|
#
|
1101
1299
|
# @!attribute [rw] player_data
|
@@ -1140,7 +1338,7 @@ module Aws::GameLift
|
|
1140
1338
|
# }
|
1141
1339
|
#
|
1142
1340
|
# @!attribute [rw] game_session_id
|
1143
|
-
#
|
1341
|
+
# A unique identifier for the game session to add players to.
|
1144
1342
|
# @return [String]
|
1145
1343
|
#
|
1146
1344
|
# @!attribute [rw] player_ids
|
@@ -1167,7 +1365,8 @@ module Aws::GameLift
|
|
1167
1365
|
# Represents the returned data in response to a request action.
|
1168
1366
|
#
|
1169
1367
|
# @!attribute [rw] player_sessions
|
1170
|
-
#
|
1368
|
+
# A collection of player session objects created for the added
|
1369
|
+
# players.
|
1171
1370
|
# @return [Array<Types::PlayerSession>]
|
1172
1371
|
#
|
1173
1372
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreatePlayerSessionsOutput AWS API Documentation
|
@@ -1190,26 +1389,32 @@ module Aws::GameLift
|
|
1190
1389
|
# object_version: "NonEmptyString",
|
1191
1390
|
# },
|
1192
1391
|
# zip_file: "data",
|
1392
|
+
# tags: [
|
1393
|
+
# {
|
1394
|
+
# key: "TagKey", # required
|
1395
|
+
# value: "TagValue", # required
|
1396
|
+
# },
|
1397
|
+
# ],
|
1193
1398
|
# }
|
1194
1399
|
#
|
1195
1400
|
# @!attribute [rw] name
|
1196
|
-
#
|
1197
|
-
# not need to be unique. You can use UpdateScript to change this
|
1198
|
-
# later.
|
1401
|
+
# A descriptive label that is associated with a script. Script names
|
1402
|
+
# do not need to be unique. You can use UpdateScript to change this
|
1403
|
+
# value later.
|
1199
1404
|
# @return [String]
|
1200
1405
|
#
|
1201
1406
|
# @!attribute [rw] version
|
1202
|
-
#
|
1203
|
-
# do not need to be unique. You can use UpdateScript to change
|
1204
|
-
# value later.
|
1407
|
+
# The version that is associated with a build or script. Version
|
1408
|
+
# strings do not need to be unique. You can use UpdateScript to change
|
1409
|
+
# this value later.
|
1205
1410
|
# @return [String]
|
1206
1411
|
#
|
1207
1412
|
# @!attribute [rw] storage_location
|
1208
|
-
#
|
1209
|
-
# Realtime scripts is stored. The storage location must specify
|
1210
|
-
# Amazon S3 bucket name, the zip file name (the "key"), and a
|
1211
|
-
# ARN that allows Amazon GameLift to access the Amazon S3 storage
|
1212
|
-
# location. The S3 bucket must be in the same
|
1413
|
+
# The location of the Amazon S3 bucket where a zipped file containing
|
1414
|
+
# your Realtime scripts is stored. The storage location must specify
|
1415
|
+
# the Amazon S3 bucket name, the zip file name (the "key"), and a
|
1416
|
+
# role ARN that allows Amazon GameLift to access the Amazon S3 storage
|
1417
|
+
# location. The S3 bucket must be in the same Region where you want to
|
1213
1418
|
# create a new script. By default, Amazon GameLift uploads the latest
|
1214
1419
|
# version of the zip file; if you have S3 object versioning turned on,
|
1215
1420
|
# you can use the `ObjectVersion` parameter to specify an earlier
|
@@ -1217,7 +1422,7 @@ module Aws::GameLift
|
|
1217
1422
|
# @return [Types::S3Location]
|
1218
1423
|
#
|
1219
1424
|
# @!attribute [rw] zip_file
|
1220
|
-
#
|
1425
|
+
# A data object containing your Realtime scripts and dependencies as a
|
1221
1426
|
# zip file. The zip file can have one or multiple files. Maximum size
|
1222
1427
|
# of a zip file is 5 MB.
|
1223
1428
|
#
|
@@ -1227,20 +1432,36 @@ module Aws::GameLift
|
|
1227
1432
|
# example: `--zip-file fileb://myRealtimeScript.zip`.
|
1228
1433
|
# @return [String]
|
1229
1434
|
#
|
1435
|
+
# @!attribute [rw] tags
|
1436
|
+
# A list of labels to assign to the new script resource. Tags are
|
1437
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
1438
|
+
# for resource management, access management and cost allocation. For
|
1439
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS
|
1440
|
+
# General Reference*. Once the resource is created, you can use
|
1441
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1442
|
+
# and view tags. The maximum tag limit may be lower than stated. See
|
1443
|
+
# the AWS General Reference for actual tagging limits.
|
1444
|
+
#
|
1445
|
+
#
|
1446
|
+
#
|
1447
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1448
|
+
# @return [Array<Types::Tag>]
|
1449
|
+
#
|
1230
1450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateScriptInput AWS API Documentation
|
1231
1451
|
#
|
1232
1452
|
class CreateScriptInput < Struct.new(
|
1233
1453
|
:name,
|
1234
1454
|
:version,
|
1235
1455
|
:storage_location,
|
1236
|
-
:zip_file
|
1456
|
+
:zip_file,
|
1457
|
+
:tags)
|
1237
1458
|
include Aws::Structure
|
1238
1459
|
end
|
1239
1460
|
|
1240
1461
|
# @!attribute [rw] script
|
1241
|
-
# The newly created script record with a unique script ID. The
|
1242
|
-
# script's storage location reflects an Amazon S3 location: (1)
|
1243
|
-
# the script was uploaded from an S3 bucket under your account, the
|
1462
|
+
# The newly created script record with a unique script ID and ARN. The
|
1463
|
+
# new script's storage location reflects an Amazon S3 location: (1)
|
1464
|
+
# If the script was uploaded from an S3 bucket under your account, the
|
1244
1465
|
# storage location reflects the information that was provided in the
|
1245
1466
|
# *CreateScript* request; (2) If the script file was uploaded from a
|
1246
1467
|
# local zip file, the storage location reflects an S3 location
|
@@ -1265,14 +1486,14 @@ module Aws::GameLift
|
|
1265
1486
|
# }
|
1266
1487
|
#
|
1267
1488
|
# @!attribute [rw] game_lift_aws_account_id
|
1268
|
-
#
|
1489
|
+
# A unique identifier for the AWS account that you use to manage your
|
1269
1490
|
# Amazon GameLift fleet. You can find your Account ID in the AWS
|
1270
1491
|
# Management Console under account settings.
|
1271
1492
|
# @return [String]
|
1272
1493
|
#
|
1273
1494
|
# @!attribute [rw] peer_vpc_id
|
1274
|
-
#
|
1275
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
1495
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
1496
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
1276
1497
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
1277
1498
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
1278
1499
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -1317,19 +1538,20 @@ module Aws::GameLift
|
|
1317
1538
|
# }
|
1318
1539
|
#
|
1319
1540
|
# @!attribute [rw] fleet_id
|
1320
|
-
#
|
1321
|
-
# GameLift VPC to peer
|
1541
|
+
# A unique identifier for a fleet. You can use either the fleet ID or
|
1542
|
+
# ARN value. This tells Amazon GameLift which GameLift VPC to peer
|
1543
|
+
# with.
|
1322
1544
|
# @return [String]
|
1323
1545
|
#
|
1324
1546
|
# @!attribute [rw] peer_vpc_aws_account_id
|
1325
|
-
#
|
1326
|
-
# peer your Amazon GameLift fleet with. You can find your Account
|
1327
|
-
# in the AWS Management Console under account settings.
|
1547
|
+
# A unique identifier for the AWS account with the VPC that you want
|
1548
|
+
# to peer your Amazon GameLift fleet with. You can find your Account
|
1549
|
+
# ID in the AWS Management Console under account settings.
|
1328
1550
|
# @return [String]
|
1329
1551
|
#
|
1330
1552
|
# @!attribute [rw] peer_vpc_id
|
1331
|
-
#
|
1332
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
1553
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
1554
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
1333
1555
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
1334
1556
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
1335
1557
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -1363,8 +1585,8 @@ module Aws::GameLift
|
|
1363
1585
|
# }
|
1364
1586
|
#
|
1365
1587
|
# @!attribute [rw] alias_id
|
1366
|
-
#
|
1367
|
-
#
|
1588
|
+
# A unique identifier of the alias that you want to delete. You can
|
1589
|
+
# use either the alias ID or ARN value.
|
1368
1590
|
# @return [String]
|
1369
1591
|
#
|
1370
1592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteAliasInput AWS API Documentation
|
@@ -1384,7 +1606,8 @@ module Aws::GameLift
|
|
1384
1606
|
# }
|
1385
1607
|
#
|
1386
1608
|
# @!attribute [rw] build_id
|
1387
|
-
#
|
1609
|
+
# A unique identifier for a build to delete. You can use either the
|
1610
|
+
# build ID or ARN value.
|
1388
1611
|
# @return [String]
|
1389
1612
|
#
|
1390
1613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteBuildInput AWS API Documentation
|
@@ -1404,7 +1627,8 @@ module Aws::GameLift
|
|
1404
1627
|
# }
|
1405
1628
|
#
|
1406
1629
|
# @!attribute [rw] fleet_id
|
1407
|
-
#
|
1630
|
+
# A unique identifier for a fleet to be deleted. You can use either
|
1631
|
+
# the fleet ID or ARN value.
|
1408
1632
|
# @return [String]
|
1409
1633
|
#
|
1410
1634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleetInput AWS API Documentation
|
@@ -1424,8 +1648,9 @@ module Aws::GameLift
|
|
1424
1648
|
# }
|
1425
1649
|
#
|
1426
1650
|
# @!attribute [rw] name
|
1427
|
-
#
|
1428
|
-
# names must be unique within each
|
1651
|
+
# A descriptive label that is associated with game session queue.
|
1652
|
+
# Queue names must be unique within each Region. You can use either
|
1653
|
+
# the queue ID or ARN value.
|
1429
1654
|
# @return [String]
|
1430
1655
|
#
|
1431
1656
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameSessionQueueInput AWS API Documentation
|
@@ -1445,11 +1670,12 @@ module Aws::GameLift
|
|
1445
1670
|
# data as a hash:
|
1446
1671
|
#
|
1447
1672
|
# {
|
1448
|
-
# name: "
|
1673
|
+
# name: "MatchmakingConfigurationName", # required
|
1449
1674
|
# }
|
1450
1675
|
#
|
1451
1676
|
# @!attribute [rw] name
|
1452
|
-
#
|
1677
|
+
# A unique identifier for a matchmaking configuration. You can use
|
1678
|
+
# either the configuration name or ARN value.
|
1453
1679
|
# @return [String]
|
1454
1680
|
#
|
1455
1681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingConfigurationInput AWS API Documentation
|
@@ -1469,13 +1695,14 @@ module Aws::GameLift
|
|
1469
1695
|
# data as a hash:
|
1470
1696
|
#
|
1471
1697
|
# {
|
1472
|
-
# name: "
|
1698
|
+
# name: "MatchmakingRuleSetName", # required
|
1473
1699
|
# }
|
1474
1700
|
#
|
1475
1701
|
# @!attribute [rw] name
|
1476
|
-
#
|
1702
|
+
# A unique identifier for a matchmaking rule set to be deleted. (Note:
|
1477
1703
|
# The rule set name is different from the optional "name" field in
|
1478
|
-
# the rule set body.)
|
1704
|
+
# the rule set body.) You can use either the rule set name or ARN
|
1705
|
+
# value.
|
1479
1706
|
# @return [String]
|
1480
1707
|
#
|
1481
1708
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingRuleSetInput AWS API Documentation
|
@@ -1502,12 +1729,13 @@ module Aws::GameLift
|
|
1502
1729
|
# }
|
1503
1730
|
#
|
1504
1731
|
# @!attribute [rw] name
|
1505
|
-
#
|
1732
|
+
# A descriptive label that is associated with a scaling policy. Policy
|
1506
1733
|
# names do not need to be unique.
|
1507
1734
|
# @return [String]
|
1508
1735
|
#
|
1509
1736
|
# @!attribute [rw] fleet_id
|
1510
|
-
#
|
1737
|
+
# A unique identifier for a fleet to be deleted. You can use either
|
1738
|
+
# the fleet ID or ARN value.
|
1511
1739
|
# @return [String]
|
1512
1740
|
#
|
1513
1741
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScalingPolicyInput AWS API Documentation
|
@@ -1526,7 +1754,8 @@ module Aws::GameLift
|
|
1526
1754
|
# }
|
1527
1755
|
#
|
1528
1756
|
# @!attribute [rw] script_id
|
1529
|
-
#
|
1757
|
+
# A unique identifier for a Realtime script to delete. You can use
|
1758
|
+
# either the script ID or ARN value.
|
1530
1759
|
# @return [String]
|
1531
1760
|
#
|
1532
1761
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScriptInput AWS API Documentation
|
@@ -1547,14 +1776,14 @@ module Aws::GameLift
|
|
1547
1776
|
# }
|
1548
1777
|
#
|
1549
1778
|
# @!attribute [rw] game_lift_aws_account_id
|
1550
|
-
#
|
1779
|
+
# A unique identifier for the AWS account that you use to manage your
|
1551
1780
|
# Amazon GameLift fleet. You can find your Account ID in the AWS
|
1552
1781
|
# Management Console under account settings.
|
1553
1782
|
# @return [String]
|
1554
1783
|
#
|
1555
1784
|
# @!attribute [rw] peer_vpc_id
|
1556
|
-
#
|
1557
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
1785
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
1786
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
1558
1787
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
1559
1788
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
1560
1789
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -1588,12 +1817,13 @@ module Aws::GameLift
|
|
1588
1817
|
# }
|
1589
1818
|
#
|
1590
1819
|
# @!attribute [rw] fleet_id
|
1591
|
-
#
|
1592
|
-
# referenced in the VPC peering connection record.
|
1820
|
+
# A unique identifier for a fleet. This fleet specified must match the
|
1821
|
+
# fleet referenced in the VPC peering connection record. You can use
|
1822
|
+
# either the fleet ID or ARN value.
|
1593
1823
|
# @return [String]
|
1594
1824
|
#
|
1595
1825
|
# @!attribute [rw] vpc_peering_connection_id
|
1596
|
-
#
|
1826
|
+
# A unique identifier for a VPC peering connection. This value is
|
1597
1827
|
# included in the VpcPeeringConnection object, which can be retrieved
|
1598
1828
|
# by calling DescribeVpcPeeringConnections.
|
1599
1829
|
# @return [String]
|
@@ -1620,8 +1850,8 @@ module Aws::GameLift
|
|
1620
1850
|
# }
|
1621
1851
|
#
|
1622
1852
|
# @!attribute [rw] alias_id
|
1623
|
-
#
|
1624
|
-
#
|
1853
|
+
# The unique identifier for the fleet alias that you want to retrieve.
|
1854
|
+
# You can use either the alias ID or ARN value.
|
1625
1855
|
# @return [String]
|
1626
1856
|
#
|
1627
1857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeAliasInput AWS API Documentation
|
@@ -1634,7 +1864,7 @@ module Aws::GameLift
|
|
1634
1864
|
# Represents the returned data in response to a request action.
|
1635
1865
|
#
|
1636
1866
|
# @!attribute [rw] alias
|
1637
|
-
#
|
1867
|
+
# The requested alias resource.
|
1638
1868
|
# @return [Types::Alias]
|
1639
1869
|
#
|
1640
1870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeAliasOutput AWS API Documentation
|
@@ -1654,7 +1884,8 @@ module Aws::GameLift
|
|
1654
1884
|
# }
|
1655
1885
|
#
|
1656
1886
|
# @!attribute [rw] build_id
|
1657
|
-
#
|
1887
|
+
# A unique identifier for a build to retrieve properties for. You can
|
1888
|
+
# use either the build ID or ARN value.
|
1658
1889
|
# @return [String]
|
1659
1890
|
#
|
1660
1891
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeBuildInput AWS API Documentation
|
@@ -1710,8 +1941,7 @@ module Aws::GameLift
|
|
1710
1941
|
# Represents the returned data in response to a request action.
|
1711
1942
|
#
|
1712
1943
|
# @!attribute [rw] ec2_instance_limits
|
1713
|
-
#
|
1714
|
-
# specified instance type.
|
1944
|
+
# The maximum number of instances for the specified instance type.
|
1715
1945
|
# @return [Array<Types::EC2InstanceLimit>]
|
1716
1946
|
#
|
1717
1947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeEC2InstanceLimitsOutput AWS API Documentation
|
@@ -1733,12 +1963,12 @@ module Aws::GameLift
|
|
1733
1963
|
# }
|
1734
1964
|
#
|
1735
1965
|
# @!attribute [rw] fleet_ids
|
1736
|
-
#
|
1737
|
-
#
|
1966
|
+
# A unique identifier for a fleet(s) to retrieve attributes for. You
|
1967
|
+
# can use either the fleet ID or ARN value.
|
1738
1968
|
# @return [Array<String>]
|
1739
1969
|
#
|
1740
1970
|
# @!attribute [rw] limit
|
1741
|
-
#
|
1971
|
+
# The maximum number of results to return. Use this parameter with
|
1742
1972
|
# `NextToken` to get results as a set of sequential pages. This
|
1743
1973
|
# parameter is ignored when the request specifies one or a list of
|
1744
1974
|
# fleet IDs.
|
@@ -1764,7 +1994,7 @@ module Aws::GameLift
|
|
1764
1994
|
# Represents the returned data in response to a request action.
|
1765
1995
|
#
|
1766
1996
|
# @!attribute [rw] fleet_attributes
|
1767
|
-
#
|
1997
|
+
# A collection of objects containing attribute metadata for each
|
1768
1998
|
# requested fleet ID.
|
1769
1999
|
# @return [Array<Types::FleetAttributes>]
|
1770
2000
|
#
|
@@ -1794,13 +2024,12 @@ module Aws::GameLift
|
|
1794
2024
|
# }
|
1795
2025
|
#
|
1796
2026
|
# @!attribute [rw] fleet_ids
|
1797
|
-
#
|
1798
|
-
# for.
|
1799
|
-
# parameter empty.
|
2027
|
+
# A unique identifier for a fleet(s) to retrieve capacity information
|
2028
|
+
# for. You can use either the fleet ID or ARN value.
|
1800
2029
|
# @return [Array<String>]
|
1801
2030
|
#
|
1802
2031
|
# @!attribute [rw] limit
|
1803
|
-
#
|
2032
|
+
# The maximum number of results to return. Use this parameter with
|
1804
2033
|
# `NextToken` to get results as a set of sequential pages. This
|
1805
2034
|
# parameter is ignored when the request specifies one or a list of
|
1806
2035
|
# fleet IDs.
|
@@ -1826,7 +2055,7 @@ module Aws::GameLift
|
|
1826
2055
|
# Represents the returned data in response to a request action.
|
1827
2056
|
#
|
1828
2057
|
# @!attribute [rw] fleet_capacity
|
1829
|
-
#
|
2058
|
+
# A collection of objects containing capacity information for each
|
1830
2059
|
# requested fleet ID. Leave this parameter empty to retrieve capacity
|
1831
2060
|
# information for all fleets.
|
1832
2061
|
# @return [Array<Types::FleetCapacity>]
|
@@ -1859,7 +2088,8 @@ module Aws::GameLift
|
|
1859
2088
|
# }
|
1860
2089
|
#
|
1861
2090
|
# @!attribute [rw] fleet_id
|
1862
|
-
#
|
2091
|
+
# A unique identifier for a fleet to get event logs for. You can use
|
2092
|
+
# either the fleet ID or ARN value.
|
1863
2093
|
# @return [String]
|
1864
2094
|
#
|
1865
2095
|
# @!attribute [rw] start_time
|
@@ -1877,7 +2107,7 @@ module Aws::GameLift
|
|
1877
2107
|
# @return [Time]
|
1878
2108
|
#
|
1879
2109
|
# @!attribute [rw] limit
|
1880
|
-
#
|
2110
|
+
# The maximum number of results to return. Use this parameter with
|
1881
2111
|
# `NextToken` to get results as a set of sequential pages.
|
1882
2112
|
# @return [Integer]
|
1883
2113
|
#
|
@@ -1902,8 +2132,8 @@ module Aws::GameLift
|
|
1902
2132
|
# Represents the returned data in response to a request action.
|
1903
2133
|
#
|
1904
2134
|
# @!attribute [rw] events
|
1905
|
-
#
|
1906
|
-
# fleet.
|
2135
|
+
# A collection of objects containing event log entries for the
|
2136
|
+
# specified fleet.
|
1907
2137
|
# @return [Array<Types::Event>]
|
1908
2138
|
#
|
1909
2139
|
# @!attribute [rw] next_token
|
@@ -1930,7 +2160,8 @@ module Aws::GameLift
|
|
1930
2160
|
# }
|
1931
2161
|
#
|
1932
2162
|
# @!attribute [rw] fleet_id
|
1933
|
-
#
|
2163
|
+
# A unique identifier for a fleet to retrieve port settings for. You
|
2164
|
+
# can use either the fleet ID or ARN value.
|
1934
2165
|
# @return [String]
|
1935
2166
|
#
|
1936
2167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettingsInput AWS API Documentation
|
@@ -1943,7 +2174,7 @@ module Aws::GameLift
|
|
1943
2174
|
# Represents the returned data in response to a request action.
|
1944
2175
|
#
|
1945
2176
|
# @!attribute [rw] inbound_permissions
|
1946
|
-
#
|
2177
|
+
# The port settings for the requested fleet ID.
|
1947
2178
|
# @return [Array<Types::IpPermission>]
|
1948
2179
|
#
|
1949
2180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetPortSettingsOutput AWS API Documentation
|
@@ -1965,13 +2196,12 @@ module Aws::GameLift
|
|
1965
2196
|
# }
|
1966
2197
|
#
|
1967
2198
|
# @!attribute [rw] fleet_ids
|
1968
|
-
#
|
1969
|
-
#
|
1970
|
-
# empty.
|
2199
|
+
# A unique identifier for a fleet(s) to retrieve utilization data for.
|
2200
|
+
# You can use either the fleet ID or ARN value.
|
1971
2201
|
# @return [Array<String>]
|
1972
2202
|
#
|
1973
2203
|
# @!attribute [rw] limit
|
1974
|
-
#
|
2204
|
+
# The maximum number of results to return. Use this parameter with
|
1975
2205
|
# `NextToken` to get results as a set of sequential pages. This
|
1976
2206
|
# parameter is ignored when the request specifies one or a list of
|
1977
2207
|
# fleet IDs.
|
@@ -1997,7 +2227,7 @@ module Aws::GameLift
|
|
1997
2227
|
# Represents the returned data in response to a request action.
|
1998
2228
|
#
|
1999
2229
|
# @!attribute [rw] fleet_utilization
|
2000
|
-
#
|
2230
|
+
# A collection of objects containing utilization information for each
|
2001
2231
|
# requested fleet ID.
|
2002
2232
|
# @return [Array<Types::FleetUtilization>]
|
2003
2233
|
#
|
@@ -2030,17 +2260,18 @@ module Aws::GameLift
|
|
2030
2260
|
# }
|
2031
2261
|
#
|
2032
2262
|
# @!attribute [rw] fleet_id
|
2033
|
-
#
|
2034
|
-
# on the fleet.
|
2263
|
+
# A unique identifier for a fleet to retrieve all game sessions active
|
2264
|
+
# on the fleet. You can use either the fleet ID or ARN value.
|
2035
2265
|
# @return [String]
|
2036
2266
|
#
|
2037
2267
|
# @!attribute [rw] game_session_id
|
2038
|
-
#
|
2268
|
+
# A unique identifier for the game session to retrieve.
|
2039
2269
|
# @return [String]
|
2040
2270
|
#
|
2041
2271
|
# @!attribute [rw] alias_id
|
2042
|
-
#
|
2043
|
-
# all game sessions for.
|
2272
|
+
# A unique identifier for an alias associated with the fleet to
|
2273
|
+
# retrieve all game sessions for. You can use either the alias ID or
|
2274
|
+
# ARN value.
|
2044
2275
|
# @return [String]
|
2045
2276
|
#
|
2046
2277
|
# @!attribute [rw] status_filter
|
@@ -2050,7 +2281,7 @@ module Aws::GameLift
|
|
2050
2281
|
# @return [String]
|
2051
2282
|
#
|
2052
2283
|
# @!attribute [rw] limit
|
2053
|
-
#
|
2284
|
+
# The maximum number of results to return. Use this parameter with
|
2054
2285
|
# `NextToken` to get results as a set of sequential pages.
|
2055
2286
|
# @return [Integer]
|
2056
2287
|
#
|
@@ -2076,7 +2307,7 @@ module Aws::GameLift
|
|
2076
2307
|
# Represents the returned data in response to a request action.
|
2077
2308
|
#
|
2078
2309
|
# @!attribute [rw] game_session_details
|
2079
|
-
#
|
2310
|
+
# A collection of objects containing game session properties and the
|
2080
2311
|
# protection policy currently in force for each session matching the
|
2081
2312
|
# request.
|
2082
2313
|
# @return [Array<Types::GameSessionDetail>]
|
@@ -2105,7 +2336,7 @@ module Aws::GameLift
|
|
2105
2336
|
# }
|
2106
2337
|
#
|
2107
2338
|
# @!attribute [rw] placement_id
|
2108
|
-
#
|
2339
|
+
# A unique identifier for a game session placement to retrieve.
|
2109
2340
|
# @return [String]
|
2110
2341
|
#
|
2111
2342
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionPlacementInput AWS API Documentation
|
@@ -2140,17 +2371,18 @@ module Aws::GameLift
|
|
2140
2371
|
# }
|
2141
2372
|
#
|
2142
2373
|
# @!attribute [rw] names
|
2143
|
-
#
|
2144
|
-
#
|
2374
|
+
# A list of queue names to retrieve information for. You can use
|
2375
|
+
# either the queue ID or ARN value. To request settings for all
|
2376
|
+
# queues, leave this parameter empty.
|
2145
2377
|
# @return [Array<String>]
|
2146
2378
|
#
|
2147
2379
|
# @!attribute [rw] limit
|
2148
|
-
#
|
2380
|
+
# The maximum number of results to return. Use this parameter with
|
2149
2381
|
# `NextToken` to get results as a set of sequential pages.
|
2150
2382
|
# @return [Integer]
|
2151
2383
|
#
|
2152
2384
|
# @!attribute [rw] next_token
|
2153
|
-
#
|
2385
|
+
# A token that indicates the start of the next sequential page of
|
2154
2386
|
# results. Use the token that is returned with a previous call to this
|
2155
2387
|
# action. To start at the beginning of the result set, do not specify
|
2156
2388
|
# a value.
|
@@ -2168,13 +2400,13 @@ module Aws::GameLift
|
|
2168
2400
|
# Represents the returned data in response to a request action.
|
2169
2401
|
#
|
2170
2402
|
# @!attribute [rw] game_session_queues
|
2171
|
-
#
|
2403
|
+
# A collection of objects that describe the requested game session
|
2172
2404
|
# queues.
|
2173
2405
|
# @return [Array<Types::GameSessionQueue>]
|
2174
2406
|
#
|
2175
2407
|
# @!attribute [rw] next_token
|
2176
|
-
#
|
2177
|
-
# call to this action. If no token is returned, these results
|
2408
|
+
# A token that indicates where to resume retrieving results on the
|
2409
|
+
# next call to this action. If no token is returned, these results
|
2178
2410
|
# represent the end of the list.
|
2179
2411
|
# @return [String]
|
2180
2412
|
#
|
@@ -2201,17 +2433,18 @@ module Aws::GameLift
|
|
2201
2433
|
# }
|
2202
2434
|
#
|
2203
2435
|
# @!attribute [rw] fleet_id
|
2204
|
-
#
|
2436
|
+
# A unique identifier for a fleet to retrieve all game sessions for.
|
2437
|
+
# You can use either the fleet ID or ARN value.
|
2205
2438
|
# @return [String]
|
2206
2439
|
#
|
2207
2440
|
# @!attribute [rw] game_session_id
|
2208
|
-
#
|
2209
|
-
# either a `GameSessionId` or `GameSessionArn` value.
|
2441
|
+
# A unique identifier for the game session to retrieve.
|
2210
2442
|
# @return [String]
|
2211
2443
|
#
|
2212
2444
|
# @!attribute [rw] alias_id
|
2213
|
-
#
|
2214
|
-
# all game sessions for.
|
2445
|
+
# A unique identifier for an alias associated with the fleet to
|
2446
|
+
# retrieve all game sessions for. You can use either the alias ID or
|
2447
|
+
# ARN value.
|
2215
2448
|
# @return [String]
|
2216
2449
|
#
|
2217
2450
|
# @!attribute [rw] status_filter
|
@@ -2221,7 +2454,7 @@ module Aws::GameLift
|
|
2221
2454
|
# @return [String]
|
2222
2455
|
#
|
2223
2456
|
# @!attribute [rw] limit
|
2224
|
-
#
|
2457
|
+
# The maximum number of results to return. Use this parameter with
|
2225
2458
|
# `NextToken` to get results as a set of sequential pages.
|
2226
2459
|
# @return [Integer]
|
2227
2460
|
#
|
@@ -2247,7 +2480,7 @@ module Aws::GameLift
|
|
2247
2480
|
# Represents the returned data in response to a request action.
|
2248
2481
|
#
|
2249
2482
|
# @!attribute [rw] game_sessions
|
2250
|
-
#
|
2483
|
+
# A collection of objects containing game session properties for each
|
2251
2484
|
# session matching the request.
|
2252
2485
|
# @return [Array<Types::GameSession>]
|
2253
2486
|
#
|
@@ -2278,16 +2511,17 @@ module Aws::GameLift
|
|
2278
2511
|
# }
|
2279
2512
|
#
|
2280
2513
|
# @!attribute [rw] fleet_id
|
2281
|
-
#
|
2514
|
+
# A unique identifier for a fleet to retrieve instance information
|
2515
|
+
# for. You can use either the fleet ID or ARN value.
|
2282
2516
|
# @return [String]
|
2283
2517
|
#
|
2284
2518
|
# @!attribute [rw] instance_id
|
2285
|
-
#
|
2519
|
+
# A unique identifier for an instance to retrieve. Specify an instance
|
2286
2520
|
# ID or leave blank to retrieve all instances in the fleet.
|
2287
2521
|
# @return [String]
|
2288
2522
|
#
|
2289
2523
|
# @!attribute [rw] limit
|
2290
|
-
#
|
2524
|
+
# The maximum number of results to return. Use this parameter with
|
2291
2525
|
# `NextToken` to get results as a set of sequential pages.
|
2292
2526
|
# @return [Integer]
|
2293
2527
|
#
|
@@ -2311,7 +2545,7 @@ module Aws::GameLift
|
|
2311
2545
|
# Represents the returned data in response to a request action.
|
2312
2546
|
#
|
2313
2547
|
# @!attribute [rw] instances
|
2314
|
-
#
|
2548
|
+
# A collection of objects containing properties for each instance
|
2315
2549
|
# returned.
|
2316
2550
|
# @return [Array<Types::Instance>]
|
2317
2551
|
#
|
@@ -2335,30 +2569,32 @@ module Aws::GameLift
|
|
2335
2569
|
# data as a hash:
|
2336
2570
|
#
|
2337
2571
|
# {
|
2338
|
-
# names: ["
|
2339
|
-
# rule_set_name: "
|
2572
|
+
# names: ["MatchmakingConfigurationName"],
|
2573
|
+
# rule_set_name: "MatchmakingRuleSetName",
|
2340
2574
|
# limit: 1,
|
2341
2575
|
# next_token: "NonZeroAndMaxString",
|
2342
2576
|
# }
|
2343
2577
|
#
|
2344
2578
|
# @!attribute [rw] names
|
2345
|
-
#
|
2346
|
-
#
|
2579
|
+
# A unique identifier for a matchmaking configuration(s) to retrieve.
|
2580
|
+
# You can use either the configuration name or ARN value. To request
|
2581
|
+
# all existing configurations, leave this parameter empty.
|
2347
2582
|
# @return [Array<String>]
|
2348
2583
|
#
|
2349
2584
|
# @!attribute [rw] rule_set_name
|
2350
|
-
#
|
2351
|
-
#
|
2585
|
+
# A unique identifier for a matchmaking rule set. You can use either
|
2586
|
+
# the rule set name or ARN value. Use this parameter to retrieve all
|
2587
|
+
# matchmaking configurations that use this rule set.
|
2352
2588
|
# @return [String]
|
2353
2589
|
#
|
2354
2590
|
# @!attribute [rw] limit
|
2355
|
-
#
|
2591
|
+
# The maximum number of results to return. Use this parameter with
|
2356
2592
|
# `NextToken` to get results as a set of sequential pages. This
|
2357
2593
|
# parameter is limited to 10.
|
2358
2594
|
# @return [Integer]
|
2359
2595
|
#
|
2360
2596
|
# @!attribute [rw] next_token
|
2361
|
-
#
|
2597
|
+
# A token that indicates the start of the next sequential page of
|
2362
2598
|
# results. Use the token that is returned with a previous call to this
|
2363
2599
|
# action. To start at the beginning of the result set, do not specify
|
2364
2600
|
# a value.
|
@@ -2377,12 +2613,12 @@ module Aws::GameLift
|
|
2377
2613
|
# Represents the returned data in response to a request action.
|
2378
2614
|
#
|
2379
2615
|
# @!attribute [rw] configurations
|
2380
|
-
#
|
2616
|
+
# A collection of requested matchmaking configurations.
|
2381
2617
|
# @return [Array<Types::MatchmakingConfiguration>]
|
2382
2618
|
#
|
2383
2619
|
# @!attribute [rw] next_token
|
2384
|
-
#
|
2385
|
-
# call to this action. If no token is returned, these results
|
2620
|
+
# A token that indicates where to resume retrieving results on the
|
2621
|
+
# next call to this action. If no token is returned, these results
|
2386
2622
|
# represent the end of the list.
|
2387
2623
|
# @return [String]
|
2388
2624
|
#
|
@@ -2404,8 +2640,8 @@ module Aws::GameLift
|
|
2404
2640
|
# }
|
2405
2641
|
#
|
2406
2642
|
# @!attribute [rw] ticket_ids
|
2407
|
-
#
|
2408
|
-
# ID values.
|
2643
|
+
# A unique identifier for a matchmaking ticket. You can include up to
|
2644
|
+
# 10 ID values.
|
2409
2645
|
# @return [Array<String>]
|
2410
2646
|
#
|
2411
2647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingInput AWS API Documentation
|
@@ -2418,7 +2654,7 @@ module Aws::GameLift
|
|
2418
2654
|
# Represents the returned data in response to a request action.
|
2419
2655
|
#
|
2420
2656
|
# @!attribute [rw] ticket_list
|
2421
|
-
#
|
2657
|
+
# A collection of existing matchmaking ticket objects matching the
|
2422
2658
|
# request.
|
2423
2659
|
# @return [Array<Types::MatchmakingTicket>]
|
2424
2660
|
#
|
@@ -2435,24 +2671,25 @@ module Aws::GameLift
|
|
2435
2671
|
# data as a hash:
|
2436
2672
|
#
|
2437
2673
|
# {
|
2438
|
-
# names: ["
|
2674
|
+
# names: ["MatchmakingRuleSetName"],
|
2439
2675
|
# limit: 1,
|
2440
2676
|
# next_token: "NonZeroAndMaxString",
|
2441
2677
|
# }
|
2442
2678
|
#
|
2443
2679
|
# @!attribute [rw] names
|
2444
|
-
#
|
2680
|
+
# A list of one or more matchmaking rule set names to retrieve details
|
2445
2681
|
# for. (Note: The rule set name is different from the optional
|
2446
|
-
# "name" field in the rule set body.)
|
2682
|
+
# "name" field in the rule set body.) You can use either the rule
|
2683
|
+
# set name or ARN value.
|
2447
2684
|
# @return [Array<String>]
|
2448
2685
|
#
|
2449
2686
|
# @!attribute [rw] limit
|
2450
|
-
#
|
2687
|
+
# The maximum number of results to return. Use this parameter with
|
2451
2688
|
# `NextToken` to get results as a set of sequential pages.
|
2452
2689
|
# @return [Integer]
|
2453
2690
|
#
|
2454
2691
|
# @!attribute [rw] next_token
|
2455
|
-
#
|
2692
|
+
# A token that indicates the start of the next sequential page of
|
2456
2693
|
# results. Use the token that is returned with a previous call to this
|
2457
2694
|
# action. To start at the beginning of the result set, do not specify
|
2458
2695
|
# a value.
|
@@ -2470,12 +2707,12 @@ module Aws::GameLift
|
|
2470
2707
|
# Represents the returned data in response to a request action.
|
2471
2708
|
#
|
2472
2709
|
# @!attribute [rw] rule_sets
|
2473
|
-
#
|
2710
|
+
# A collection of requested matchmaking rule set objects.
|
2474
2711
|
# @return [Array<Types::MatchmakingRuleSet>]
|
2475
2712
|
#
|
2476
2713
|
# @!attribute [rw] next_token
|
2477
|
-
#
|
2478
|
-
# call to this action. If no token is returned, these results
|
2714
|
+
# A token that indicates where to resume retrieving results on the
|
2715
|
+
# next call to this action. If no token is returned, these results
|
2479
2716
|
# represent the end of the list.
|
2480
2717
|
# @return [String]
|
2481
2718
|
#
|
@@ -2502,16 +2739,16 @@ module Aws::GameLift
|
|
2502
2739
|
# }
|
2503
2740
|
#
|
2504
2741
|
# @!attribute [rw] game_session_id
|
2505
|
-
#
|
2742
|
+
# A unique identifier for the game session to retrieve player sessions
|
2506
2743
|
# for.
|
2507
2744
|
# @return [String]
|
2508
2745
|
#
|
2509
2746
|
# @!attribute [rw] player_id
|
2510
|
-
#
|
2747
|
+
# A unique identifier for a player to retrieve player sessions for.
|
2511
2748
|
# @return [String]
|
2512
2749
|
#
|
2513
2750
|
# @!attribute [rw] player_session_id
|
2514
|
-
#
|
2751
|
+
# A unique identifier for a player session to retrieve.
|
2515
2752
|
# @return [String]
|
2516
2753
|
#
|
2517
2754
|
# @!attribute [rw] player_session_status_filter
|
@@ -2534,7 +2771,7 @@ module Aws::GameLift
|
|
2534
2771
|
# @return [String]
|
2535
2772
|
#
|
2536
2773
|
# @!attribute [rw] limit
|
2537
|
-
#
|
2774
|
+
# The maximum number of results to return. Use this parameter with
|
2538
2775
|
# `NextToken` to get results as a set of sequential pages. If a player
|
2539
2776
|
# session ID is specified, this parameter is ignored.
|
2540
2777
|
# @return [Integer]
|
@@ -2562,8 +2799,8 @@ module Aws::GameLift
|
|
2562
2799
|
# Represents the returned data in response to a request action.
|
2563
2800
|
#
|
2564
2801
|
# @!attribute [rw] player_sessions
|
2565
|
-
#
|
2566
|
-
# that matches the request.
|
2802
|
+
# A collection of objects containing properties for each player
|
2803
|
+
# session that matches the request.
|
2567
2804
|
# @return [Array<Types::PlayerSession>]
|
2568
2805
|
#
|
2569
2806
|
# @!attribute [rw] next_token
|
@@ -2590,7 +2827,8 @@ module Aws::GameLift
|
|
2590
2827
|
# }
|
2591
2828
|
#
|
2592
2829
|
# @!attribute [rw] fleet_id
|
2593
|
-
#
|
2830
|
+
# A unique identifier for a fleet to get the runtime configuration
|
2831
|
+
# for. You can use either the fleet ID or ARN value.
|
2594
2832
|
# @return [String]
|
2595
2833
|
#
|
2596
2834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeRuntimeConfigurationInput AWS API Documentation
|
@@ -2627,7 +2865,8 @@ module Aws::GameLift
|
|
2627
2865
|
# }
|
2628
2866
|
#
|
2629
2867
|
# @!attribute [rw] fleet_id
|
2630
|
-
#
|
2868
|
+
# A unique identifier for a fleet to retrieve scaling policies for.
|
2869
|
+
# You can use either the fleet ID or ARN value.
|
2631
2870
|
# @return [String]
|
2632
2871
|
#
|
2633
2872
|
# @!attribute [rw] status_filter
|
@@ -2653,7 +2892,7 @@ module Aws::GameLift
|
|
2653
2892
|
# @return [String]
|
2654
2893
|
#
|
2655
2894
|
# @!attribute [rw] limit
|
2656
|
-
#
|
2895
|
+
# The maximum number of results to return. Use this parameter with
|
2657
2896
|
# `NextToken` to get results as a set of sequential pages.
|
2658
2897
|
# @return [Integer]
|
2659
2898
|
#
|
@@ -2677,7 +2916,7 @@ module Aws::GameLift
|
|
2677
2916
|
# Represents the returned data in response to a request action.
|
2678
2917
|
#
|
2679
2918
|
# @!attribute [rw] scaling_policies
|
2680
|
-
#
|
2919
|
+
# A collection of objects containing the scaling policies matching the
|
2681
2920
|
# request.
|
2682
2921
|
# @return [Array<Types::ScalingPolicy>]
|
2683
2922
|
#
|
@@ -2703,7 +2942,8 @@ module Aws::GameLift
|
|
2703
2942
|
# }
|
2704
2943
|
#
|
2705
2944
|
# @!attribute [rw] script_id
|
2706
|
-
#
|
2945
|
+
# A unique identifier for a Realtime script to retrieve properties
|
2946
|
+
# for. You can use either the script ID or ARN value.
|
2707
2947
|
# @return [String]
|
2708
2948
|
#
|
2709
2949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScriptInput AWS API Documentation
|
@@ -2714,7 +2954,7 @@ module Aws::GameLift
|
|
2714
2954
|
end
|
2715
2955
|
|
2716
2956
|
# @!attribute [rw] script
|
2717
|
-
#
|
2957
|
+
# A set of properties describing the requested script.
|
2718
2958
|
# @return [Types::Script]
|
2719
2959
|
#
|
2720
2960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScriptOutput AWS API Documentation
|
@@ -2731,8 +2971,8 @@ module Aws::GameLift
|
|
2731
2971
|
class DescribeVpcPeeringAuthorizationsInput < Aws::EmptyStructure; end
|
2732
2972
|
|
2733
2973
|
# @!attribute [rw] vpc_peering_authorizations
|
2734
|
-
#
|
2735
|
-
# for the current AWS account.
|
2974
|
+
# A collection of objects that describe all valid VPC peering
|
2975
|
+
# operations for the current AWS account.
|
2736
2976
|
# @return [Array<Types::VpcPeeringAuthorization>]
|
2737
2977
|
#
|
2738
2978
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringAuthorizationsOutput AWS API Documentation
|
@@ -2752,7 +2992,8 @@ module Aws::GameLift
|
|
2752
2992
|
# }
|
2753
2993
|
#
|
2754
2994
|
# @!attribute [rw] fleet_id
|
2755
|
-
#
|
2995
|
+
# A unique identifier for a fleet. You can use either the fleet ID or
|
2996
|
+
# ARN value.
|
2756
2997
|
# @return [String]
|
2757
2998
|
#
|
2758
2999
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringConnectionsInput AWS API Documentation
|
@@ -2765,7 +3006,8 @@ module Aws::GameLift
|
|
2765
3006
|
# Represents the returned data in response to a request action.
|
2766
3007
|
#
|
2767
3008
|
# @!attribute [rw] vpc_peering_connections
|
2768
|
-
#
|
3009
|
+
# A collection of VPC peering connection records that match the
|
3010
|
+
# request.
|
2769
3011
|
# @return [Array<Types::VpcPeeringConnection>]
|
2770
3012
|
#
|
2771
3013
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeVpcPeeringConnectionsOutput AWS API Documentation
|
@@ -2787,7 +3029,8 @@ module Aws::GameLift
|
|
2787
3029
|
# }
|
2788
3030
|
#
|
2789
3031
|
# @!attribute [rw] player_id
|
2790
|
-
#
|
3032
|
+
# A unique identifier for a player to associate with the player
|
3033
|
+
# session.
|
2791
3034
|
# @return [String]
|
2792
3035
|
#
|
2793
3036
|
# @!attribute [rw] player_data
|
@@ -2816,31 +3059,9 @@ module Aws::GameLift
|
|
2816
3059
|
#
|
2817
3060
|
# * DeleteFleet
|
2818
3061
|
#
|
2819
|
-
# *
|
2820
|
-
#
|
2821
|
-
# * DescribeFleetAttributes
|
2822
|
-
#
|
2823
|
-
# * DescribeFleetCapacity
|
2824
|
-
#
|
2825
|
-
# * DescribeFleetPortSettings
|
2826
|
-
#
|
2827
|
-
# * DescribeFleetUtilization
|
2828
|
-
#
|
2829
|
-
# * DescribeRuntimeConfiguration
|
2830
|
-
#
|
2831
|
-
# * DescribeEC2InstanceLimits
|
3062
|
+
# * DescribeFleetAttributes
|
2832
3063
|
#
|
2833
|
-
#
|
2834
|
-
#
|
2835
|
-
# * Update fleets:
|
2836
|
-
#
|
2837
|
-
# * UpdateFleetAttributes
|
2838
|
-
#
|
2839
|
-
# * UpdateFleetCapacity
|
2840
|
-
#
|
2841
|
-
# * UpdateFleetPortSettings
|
2842
|
-
#
|
2843
|
-
# * UpdateRuntimeConfiguration
|
3064
|
+
# * UpdateFleetAttributes
|
2844
3065
|
#
|
2845
3066
|
# * Manage fleet actions:
|
2846
3067
|
#
|
@@ -2853,11 +3074,11 @@ module Aws::GameLift
|
|
2853
3074
|
# @return [Integer]
|
2854
3075
|
#
|
2855
3076
|
# @!attribute [rw] minimum
|
2856
|
-
#
|
3077
|
+
# The minimum value allowed for the fleet's instance count.
|
2857
3078
|
# @return [Integer]
|
2858
3079
|
#
|
2859
3080
|
# @!attribute [rw] maximum
|
2860
|
-
#
|
3081
|
+
# The maximum value allowed for the fleet's instance count.
|
2861
3082
|
# @return [Integer]
|
2862
3083
|
#
|
2863
3084
|
# @!attribute [rw] pending
|
@@ -2892,7 +3113,7 @@ module Aws::GameLift
|
|
2892
3113
|
include Aws::Structure
|
2893
3114
|
end
|
2894
3115
|
|
2895
|
-
#
|
3116
|
+
# The maximum number of instances allowed based on the Amazon Elastic
|
2896
3117
|
# Compute Cloud (Amazon EC2) instance type. Instance limits can be
|
2897
3118
|
# retrieved by calling DescribeEC2InstanceLimits.
|
2898
3119
|
#
|
@@ -2933,18 +3154,17 @@ module Aws::GameLift
|
|
2933
3154
|
# debugging problems.
|
2934
3155
|
#
|
2935
3156
|
# @!attribute [rw] event_id
|
2936
|
-
#
|
3157
|
+
# A unique identifier for a fleet event.
|
2937
3158
|
# @return [String]
|
2938
3159
|
#
|
2939
3160
|
# @!attribute [rw] resource_id
|
2940
|
-
#
|
3161
|
+
# A unique identifier for an event resource, such as a fleet ID.
|
2941
3162
|
# @return [String]
|
2942
3163
|
#
|
2943
3164
|
# @!attribute [rw] event_code
|
2944
|
-
#
|
2945
|
-
# use:
|
3165
|
+
# The type of event being logged.
|
2946
3166
|
#
|
2947
|
-
# **Fleet creation events:**
|
3167
|
+
# **Fleet creation events (ordered by fleet creation activity):**
|
2948
3168
|
#
|
2949
3169
|
# * FLEET\_CREATED -- A fleet record was successfully created with a
|
2950
3170
|
# status of `NEW`. Event messaging includes the fleet ID.
|
@@ -2975,11 +3195,11 @@ module Aws::GameLift
|
|
2975
3195
|
# * FLEET\_CREATION\_VALIDATING\_RUNTIME\_CONFIG -- The build process
|
2976
3196
|
# was successful, and the Amazon GameLift is now verifying that the
|
2977
3197
|
# game server launch paths, which are specified in the fleet's
|
2978
|
-
#
|
3198
|
+
# runtime configuration, exist. If any listed launch path exists,
|
2979
3199
|
# Amazon GameLift tries to launch a game server process and waits
|
2980
3200
|
# for the process to report ready. Failures in this stage prevent a
|
2981
3201
|
# fleet from moving to `ACTIVE` status. Logs for this stage list the
|
2982
|
-
# launch paths in the
|
3202
|
+
# launch paths in the runtime configuration and indicate whether
|
2983
3203
|
# each is found. Access the logs by using the URL in
|
2984
3204
|
# *PreSignedLogUrl*.
|
2985
3205
|
#
|
@@ -2987,14 +3207,14 @@ module Aws::GameLift
|
|
2987
3207
|
# `DOWNLOADING` to `VALIDATING`.
|
2988
3208
|
#
|
2989
3209
|
# * FLEET\_VALIDATION\_LAUNCH\_PATH\_NOT\_FOUND -- Validation of the
|
2990
|
-
#
|
2991
|
-
#
|
3210
|
+
# runtime configuration failed because the executable specified in a
|
3211
|
+
# launch path does not exist on the instance.
|
2992
3212
|
#
|
2993
3213
|
# * FLEET\_STATE\_BUILDING -- Fleet status changed from `VALIDATING`
|
2994
3214
|
# to `BUILDING`.
|
2995
3215
|
#
|
2996
3216
|
# * FLEET\_VALIDATION\_EXECUTABLE\_RUNTIME\_FAILURE -- Validation of
|
2997
|
-
# the
|
3217
|
+
# the runtime configuration failed because the executable specified
|
2998
3218
|
# in a launch path failed to run on the fleet instance.
|
2999
3219
|
#
|
3000
3220
|
# * FLEET\_STATE\_ACTIVATING -- Fleet status changed from `BUILDING`
|
@@ -3004,9 +3224,8 @@ module Aws::GameLift
|
|
3004
3224
|
# complete one of the steps in the fleet activation process. This
|
3005
3225
|
# event code indicates that the game build was successfully
|
3006
3226
|
# downloaded to a fleet instance, built, and validated, but was not
|
3007
|
-
# able to start a server process.
|
3008
|
-
#
|
3009
|
-
# Amazon GameLift service.
|
3227
|
+
# able to start a server process. Learn more at [ Debug Fleet
|
3228
|
+
# Creation Issues][1]
|
3010
3229
|
#
|
3011
3230
|
# * FLEET\_STATE\_ACTIVE -- The fleet's status changed from
|
3012
3231
|
# `ACTIVATING` to `ACTIVE`. The fleet is now ready to host game
|
@@ -3025,7 +3244,7 @@ module Aws::GameLift
|
|
3025
3244
|
# CIDR blocks of IPv4 addresses. To resolve this, change the CIDR
|
3026
3245
|
# block for the VPC in your AWS account. For more information on VPC
|
3027
3246
|
# peering failures, see
|
3028
|
-
# [https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html][
|
3247
|
+
# [https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html][2]
|
3029
3248
|
#
|
3030
3249
|
# * FLEET\_VPC\_PEERING\_DELETED -- A VPC peering connection has been
|
3031
3250
|
# successfully deleted.
|
@@ -3053,7 +3272,8 @@ module Aws::GameLift
|
|
3053
3272
|
#
|
3054
3273
|
#
|
3055
3274
|
#
|
3056
|
-
# [1]: https://docs.aws.amazon.com/
|
3275
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation
|
3276
|
+
# [2]: https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
|
3057
3277
|
# @return [String]
|
3058
3278
|
#
|
3059
3279
|
# @!attribute [rw] message
|
@@ -3093,31 +3313,9 @@ module Aws::GameLift
|
|
3093
3313
|
#
|
3094
3314
|
# * DeleteFleet
|
3095
3315
|
#
|
3096
|
-
# *
|
3097
|
-
#
|
3098
|
-
# * DescribeFleetAttributes
|
3099
|
-
#
|
3100
|
-
# * DescribeFleetCapacity
|
3101
|
-
#
|
3102
|
-
# * DescribeFleetPortSettings
|
3103
|
-
#
|
3104
|
-
# * DescribeFleetUtilization
|
3105
|
-
#
|
3106
|
-
# * DescribeRuntimeConfiguration
|
3107
|
-
#
|
3108
|
-
# * DescribeEC2InstanceLimits
|
3109
|
-
#
|
3110
|
-
# * DescribeFleetEvents
|
3111
|
-
#
|
3112
|
-
# * Update fleets:
|
3113
|
-
#
|
3114
|
-
# * UpdateFleetAttributes
|
3316
|
+
# * DescribeFleetAttributes
|
3115
3317
|
#
|
3116
|
-
#
|
3117
|
-
#
|
3118
|
-
# * UpdateFleetPortSettings
|
3119
|
-
#
|
3120
|
-
# * UpdateRuntimeConfiguration
|
3318
|
+
# * UpdateFleetAttributes
|
3121
3319
|
#
|
3122
3320
|
# * Manage fleet actions:
|
3123
3321
|
#
|
@@ -3126,11 +3324,18 @@ module Aws::GameLift
|
|
3126
3324
|
# * StopFleetActions
|
3127
3325
|
#
|
3128
3326
|
# @!attribute [rw] fleet_id
|
3129
|
-
#
|
3327
|
+
# A unique identifier for a fleet.
|
3130
3328
|
# @return [String]
|
3131
3329
|
#
|
3132
3330
|
# @!attribute [rw] fleet_arn
|
3133
|
-
#
|
3331
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to a GameLift
|
3332
|
+
# fleet resource and uniquely identifies it. ARNs are unique across
|
3333
|
+
# all Regions. In a GameLift fleet ARN, the resource ID matches the
|
3334
|
+
# *FleetId* value.
|
3335
|
+
#
|
3336
|
+
#
|
3337
|
+
#
|
3338
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3134
3339
|
# @return [String]
|
3135
3340
|
#
|
3136
3341
|
# @!attribute [rw] fleet_type
|
@@ -3154,7 +3359,7 @@ module Aws::GameLift
|
|
3154
3359
|
# @return [String]
|
3155
3360
|
#
|
3156
3361
|
# @!attribute [rw] name
|
3157
|
-
#
|
3362
|
+
# A descriptive label that is associated with a fleet. Fleet names do
|
3158
3363
|
# not need to be unique.
|
3159
3364
|
# @return [String]
|
3160
3365
|
#
|
@@ -3193,11 +3398,31 @@ module Aws::GameLift
|
|
3193
3398
|
# @return [String]
|
3194
3399
|
#
|
3195
3400
|
# @!attribute [rw] build_id
|
3196
|
-
#
|
3401
|
+
# A unique identifier for a build.
|
3402
|
+
# @return [String]
|
3403
|
+
#
|
3404
|
+
# @!attribute [rw] build_arn
|
3405
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
3406
|
+
# build resource that is deployed on instances in this fleet. In a
|
3407
|
+
# GameLift build ARN, the resource ID matches the *BuildId* value.
|
3408
|
+
#
|
3409
|
+
#
|
3410
|
+
#
|
3411
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3197
3412
|
# @return [String]
|
3198
3413
|
#
|
3199
3414
|
# @!attribute [rw] script_id
|
3200
|
-
#
|
3415
|
+
# A unique identifier for a Realtime script.
|
3416
|
+
# @return [String]
|
3417
|
+
#
|
3418
|
+
# @!attribute [rw] script_arn
|
3419
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
3420
|
+
# script resource that is deployed on instances in this fleet. In a
|
3421
|
+
# GameLift script ARN, the resource ID matches the *ScriptId* value.
|
3422
|
+
#
|
3423
|
+
#
|
3424
|
+
#
|
3425
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3201
3426
|
# @return [String]
|
3202
3427
|
#
|
3203
3428
|
# @!attribute [rw] server_launch_path
|
@@ -3230,8 +3455,8 @@ module Aws::GameLift
|
|
3230
3455
|
# @return [Array<String>]
|
3231
3456
|
#
|
3232
3457
|
# @!attribute [rw] new_game_session_protection_policy
|
3233
|
-
#
|
3234
|
-
# in the fleet.
|
3458
|
+
# The type of game session protection to set for all new instances
|
3459
|
+
# started in the fleet.
|
3235
3460
|
#
|
3236
3461
|
# * **NoProtection** -- The game session can be terminated during a
|
3237
3462
|
# scale-down event.
|
@@ -3264,14 +3489,14 @@ module Aws::GameLift
|
|
3264
3489
|
# @return [Array<String>]
|
3265
3490
|
#
|
3266
3491
|
# @!attribute [rw] instance_role_arn
|
3267
|
-
#
|
3492
|
+
# A unique identifier for an AWS IAM role that manages access to your
|
3268
3493
|
# AWS services. With an instance role ARN set, any application that
|
3269
3494
|
# runs on an instance in this fleet can assume the role, including
|
3270
|
-
# install scripts, server processes, daemons (background
|
3271
|
-
# Create a role or look up a role's ARN
|
3272
|
-
# in the AWS Management Console. Learn more about using
|
3273
|
-
# credentials for your game servers at [ Access external
|
3274
|
-
# from a game server][2].
|
3495
|
+
# install scripts, server processes, and daemons (background
|
3496
|
+
# processes). Create a role or look up a role's ARN from the [IAM
|
3497
|
+
# dashboard][1] in the AWS Management Console. Learn more about using
|
3498
|
+
# on-box credentials for your game servers at [ Access external
|
3499
|
+
# resources from a game server][2].
|
3275
3500
|
#
|
3276
3501
|
#
|
3277
3502
|
#
|
@@ -3280,6 +3505,7 @@ module Aws::GameLift
|
|
3280
3505
|
# @return [String]
|
3281
3506
|
#
|
3282
3507
|
# @!attribute [rw] certificate_configuration
|
3508
|
+
# Indicates whether a TLS/SSL certificate was generated for the fleet.
|
3283
3509
|
# @return [Types::CertificateConfiguration]
|
3284
3510
|
#
|
3285
3511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetAttributes AWS API Documentation
|
@@ -3295,7 +3521,9 @@ module Aws::GameLift
|
|
3295
3521
|
:termination_time,
|
3296
3522
|
:status,
|
3297
3523
|
:build_id,
|
3524
|
+
:build_arn,
|
3298
3525
|
:script_id,
|
3526
|
+
:script_arn,
|
3299
3527
|
:server_launch_path,
|
3300
3528
|
:server_launch_parameters,
|
3301
3529
|
:log_paths,
|
@@ -3320,31 +3548,9 @@ module Aws::GameLift
|
|
3320
3548
|
#
|
3321
3549
|
# * DeleteFleet
|
3322
3550
|
#
|
3323
|
-
# *
|
3324
|
-
#
|
3325
|
-
# * DescribeFleetAttributes
|
3326
|
-
#
|
3327
|
-
# * DescribeFleetCapacity
|
3328
|
-
#
|
3329
|
-
# * DescribeFleetPortSettings
|
3330
|
-
#
|
3331
|
-
# * DescribeFleetUtilization
|
3332
|
-
#
|
3333
|
-
# * DescribeRuntimeConfiguration
|
3334
|
-
#
|
3335
|
-
# * DescribeEC2InstanceLimits
|
3336
|
-
#
|
3337
|
-
# * DescribeFleetEvents
|
3551
|
+
# * DescribeFleetAttributes
|
3338
3552
|
#
|
3339
|
-
# *
|
3340
|
-
#
|
3341
|
-
# * UpdateFleetAttributes
|
3342
|
-
#
|
3343
|
-
# * UpdateFleetCapacity
|
3344
|
-
#
|
3345
|
-
# * UpdateFleetPortSettings
|
3346
|
-
#
|
3347
|
-
# * UpdateRuntimeConfiguration
|
3553
|
+
# * UpdateFleetAttributes
|
3348
3554
|
#
|
3349
3555
|
# * Manage fleet actions:
|
3350
3556
|
#
|
@@ -3353,7 +3559,7 @@ module Aws::GameLift
|
|
3353
3559
|
# * StopFleetActions
|
3354
3560
|
#
|
3355
3561
|
# @!attribute [rw] fleet_id
|
3356
|
-
#
|
3562
|
+
# A unique identifier for a fleet.
|
3357
3563
|
# @return [String]
|
3358
3564
|
#
|
3359
3565
|
# @!attribute [rw] instance_type
|
@@ -3405,31 +3611,9 @@ module Aws::GameLift
|
|
3405
3611
|
#
|
3406
3612
|
# * DeleteFleet
|
3407
3613
|
#
|
3408
|
-
# *
|
3409
|
-
#
|
3410
|
-
# * DescribeFleetAttributes
|
3411
|
-
#
|
3412
|
-
# * DescribeFleetCapacity
|
3413
|
-
#
|
3414
|
-
# * DescribeFleetPortSettings
|
3614
|
+
# * DescribeFleetAttributes
|
3415
3615
|
#
|
3416
|
-
#
|
3417
|
-
#
|
3418
|
-
# * DescribeRuntimeConfiguration
|
3419
|
-
#
|
3420
|
-
# * DescribeEC2InstanceLimits
|
3421
|
-
#
|
3422
|
-
# * DescribeFleetEvents
|
3423
|
-
#
|
3424
|
-
# * Update fleets:
|
3425
|
-
#
|
3426
|
-
# * UpdateFleetAttributes
|
3427
|
-
#
|
3428
|
-
# * UpdateFleetCapacity
|
3429
|
-
#
|
3430
|
-
# * UpdateFleetPortSettings
|
3431
|
-
#
|
3432
|
-
# * UpdateRuntimeConfiguration
|
3616
|
+
# * UpdateFleetAttributes
|
3433
3617
|
#
|
3434
3618
|
# * Manage fleet actions:
|
3435
3619
|
#
|
@@ -3438,7 +3622,7 @@ module Aws::GameLift
|
|
3438
3622
|
# * StopFleetActions
|
3439
3623
|
#
|
3440
3624
|
# @!attribute [rw] fleet_id
|
3441
|
-
#
|
3625
|
+
# A unique identifier for a fleet.
|
3442
3626
|
# @return [String]
|
3443
3627
|
#
|
3444
3628
|
# @!attribute [rw] active_server_process_count
|
@@ -3457,8 +3641,8 @@ module Aws::GameLift
|
|
3457
3641
|
# @return [Integer]
|
3458
3642
|
#
|
3459
3643
|
# @!attribute [rw] maximum_player_session_count
|
3460
|
-
#
|
3461
|
-
# hosted on all instances in the fleet.
|
3644
|
+
# The maximum number of players allowed across all game sessions
|
3645
|
+
# currently being hosted on all instances in the fleet.
|
3462
3646
|
# @return [Integer]
|
3463
3647
|
#
|
3464
3648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/FleetUtilization AWS API Documentation
|
@@ -3474,11 +3658,11 @@ module Aws::GameLift
|
|
3474
3658
|
|
3475
3659
|
# Set of key-value pairs that contain information about a game session.
|
3476
3660
|
# When included in a game session request, these properties communicate
|
3477
|
-
# details to be used when setting up the new game session
|
3478
|
-
# specify a game mode, level, or map. Game
|
3479
|
-
# game server process when initiating a new
|
3480
|
-
#
|
3481
|
-
#
|
3661
|
+
# details to be used when setting up the new game session. For example,
|
3662
|
+
# a game property might specify a game mode, level, or map. Game
|
3663
|
+
# properties are passed to the game server process when initiating a new
|
3664
|
+
# game session. For more information, see the [ Amazon GameLift
|
3665
|
+
# Developer Guide][1].
|
3482
3666
|
#
|
3483
3667
|
#
|
3484
3668
|
#
|
@@ -3493,11 +3677,11 @@ module Aws::GameLift
|
|
3493
3677
|
# }
|
3494
3678
|
#
|
3495
3679
|
# @!attribute [rw] key
|
3496
|
-
#
|
3680
|
+
# The game property identifier.
|
3497
3681
|
# @return [String]
|
3498
3682
|
#
|
3499
3683
|
# @!attribute [rw] value
|
3500
|
-
#
|
3684
|
+
# The game property value.
|
3501
3685
|
# @return [String]
|
3502
3686
|
#
|
3503
3687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameProperty AWS API Documentation
|
@@ -3538,18 +3722,27 @@ module Aws::GameLift
|
|
3538
3722
|
# * StopGameSessionPlacement
|
3539
3723
|
#
|
3540
3724
|
# @!attribute [rw] game_session_id
|
3541
|
-
#
|
3725
|
+
# A unique identifier for the game session. A game session ARN has the
|
3542
3726
|
# following format: `arn:aws:gamelift:<region>::gamesession/<fleet
|
3543
3727
|
# ID>/<custom ID string or idempotency token>`.
|
3544
3728
|
# @return [String]
|
3545
3729
|
#
|
3546
3730
|
# @!attribute [rw] name
|
3547
|
-
#
|
3731
|
+
# A descriptive label that is associated with a game session. Session
|
3548
3732
|
# names do not need to be unique.
|
3549
3733
|
# @return [String]
|
3550
3734
|
#
|
3551
3735
|
# @!attribute [rw] fleet_id
|
3552
|
-
#
|
3736
|
+
# A unique identifier for a fleet that the game session is running on.
|
3737
|
+
# @return [String]
|
3738
|
+
#
|
3739
|
+
# @!attribute [rw] fleet_arn
|
3740
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
3741
|
+
# fleet that this game session is running on.
|
3742
|
+
#
|
3743
|
+
#
|
3744
|
+
#
|
3745
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3553
3746
|
# @return [String]
|
3554
3747
|
#
|
3555
3748
|
# @!attribute [rw] creation_time
|
@@ -3569,8 +3762,8 @@ module Aws::GameLift
|
|
3569
3762
|
# @return [Integer]
|
3570
3763
|
#
|
3571
3764
|
# @!attribute [rw] maximum_player_session_count
|
3572
|
-
#
|
3573
|
-
# the game session.
|
3765
|
+
# The maximum number of players that can be connected simultaneously
|
3766
|
+
# to the game session.
|
3574
3767
|
# @return [Integer]
|
3575
3768
|
#
|
3576
3769
|
# @!attribute [rw] status
|
@@ -3598,11 +3791,28 @@ module Aws::GameLift
|
|
3598
3791
|
# @return [Array<Types::GameProperty>]
|
3599
3792
|
#
|
3600
3793
|
# @!attribute [rw] ip_address
|
3601
|
-
# IP address of the
|
3602
|
-
#
|
3794
|
+
# IP address of the instance that is running the game session. When
|
3795
|
+
# connecting to a Amazon GameLift game server, a client needs to
|
3796
|
+
# reference an IP address (or DNS name) and port number.
|
3603
3797
|
# @return [String]
|
3604
3798
|
#
|
3605
3799
|
# @!attribute [rw] dns_name
|
3800
|
+
# DNS identifier assigned to the instance that is running the game
|
3801
|
+
# session. Values have the following format:
|
3802
|
+
#
|
3803
|
+
# * TLS-enabled fleets: `<unique identifier>.<region
|
3804
|
+
# identifier>.amazongamelift.com`.
|
3805
|
+
#
|
3806
|
+
# * Non-TLS-enabled fleets: `ec2-<unique
|
3807
|
+
# identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP
|
3808
|
+
# Addressing][1].)
|
3809
|
+
#
|
3810
|
+
# When connecting to a game session that is running on a TLS-enabled
|
3811
|
+
# fleet, you must use the DNS name, not the IP address.
|
3812
|
+
#
|
3813
|
+
#
|
3814
|
+
#
|
3815
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
|
3606
3816
|
# @return [String]
|
3607
3817
|
#
|
3608
3818
|
# @!attribute [rw] port
|
@@ -3615,7 +3825,7 @@ module Aws::GameLift
|
|
3615
3825
|
# @return [String]
|
3616
3826
|
#
|
3617
3827
|
# @!attribute [rw] creator_id
|
3618
|
-
#
|
3828
|
+
# A unique identifier for a player. This ID is used to enforce a
|
3619
3829
|
# resource protection policy (if one exists), that limits the number
|
3620
3830
|
# of game sessions a player can create.
|
3621
3831
|
# @return [String]
|
@@ -3652,6 +3862,7 @@ module Aws::GameLift
|
|
3652
3862
|
:game_session_id,
|
3653
3863
|
:name,
|
3654
3864
|
:fleet_id,
|
3865
|
+
:fleet_arn,
|
3655
3866
|
:creation_time,
|
3656
3867
|
:termination_time,
|
3657
3868
|
:current_player_session_count,
|
@@ -3683,15 +3894,32 @@ module Aws::GameLift
|
|
3683
3894
|
#
|
3684
3895
|
#
|
3685
3896
|
#
|
3686
|
-
# [1]: https://docs.aws.amazon.com/
|
3897
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3687
3898
|
# @return [String]
|
3688
3899
|
#
|
3689
3900
|
# @!attribute [rw] ip_address
|
3690
|
-
# IP address of the
|
3691
|
-
#
|
3901
|
+
# IP address of the instance that is running the game session. When
|
3902
|
+
# connecting to a Amazon GameLift game server, a client needs to
|
3903
|
+
# reference an IP address (or DNS name) and port number.
|
3692
3904
|
# @return [String]
|
3693
3905
|
#
|
3694
3906
|
# @!attribute [rw] dns_name
|
3907
|
+
# DNS identifier assigned to the instance that is running the game
|
3908
|
+
# session. Values have the following format:
|
3909
|
+
#
|
3910
|
+
# * TLS-enabled fleets: `<unique identifier>.<region
|
3911
|
+
# identifier>.amazongamelift.com`.
|
3912
|
+
#
|
3913
|
+
# * Non-TLS-enabled fleets: `ec2-<unique
|
3914
|
+
# identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP
|
3915
|
+
# Addressing][1].)
|
3916
|
+
#
|
3917
|
+
# When connecting to a game session that is running on a TLS-enabled
|
3918
|
+
# fleet, you must use the DNS name, not the IP address.
|
3919
|
+
#
|
3920
|
+
#
|
3921
|
+
#
|
3922
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
|
3695
3923
|
# @return [String]
|
3696
3924
|
#
|
3697
3925
|
# @!attribute [rw] port
|
@@ -3700,7 +3928,7 @@ module Aws::GameLift
|
|
3700
3928
|
# @return [Integer]
|
3701
3929
|
#
|
3702
3930
|
# @!attribute [rw] matched_player_sessions
|
3703
|
-
#
|
3931
|
+
# A collection of player session IDs, one for each player ID that was
|
3704
3932
|
# included in the original matchmaking request.
|
3705
3933
|
# @return [Array<Types::MatchedPlayerSession>]
|
3706
3934
|
#
|
@@ -3767,12 +3995,12 @@ module Aws::GameLift
|
|
3767
3995
|
# * StopGameSessionPlacement
|
3768
3996
|
#
|
3769
3997
|
# @!attribute [rw] placement_id
|
3770
|
-
#
|
3998
|
+
# A unique identifier for a game session placement.
|
3771
3999
|
# @return [String]
|
3772
4000
|
#
|
3773
4001
|
# @!attribute [rw] game_session_queue_name
|
3774
|
-
#
|
3775
|
-
# names must be unique within each
|
4002
|
+
# A descriptive label that is associated with game session queue.
|
4003
|
+
# Queue names must be unique within each Region.
|
3776
4004
|
# @return [String]
|
3777
4005
|
#
|
3778
4006
|
# @!attribute [rw] status
|
@@ -3791,6 +4019,11 @@ module Aws::GameLift
|
|
3791
4019
|
# * **TIMED\_OUT** -- A new game session was not successfully created
|
3792
4020
|
# before the time limit expired. You can resubmit the placement
|
3793
4021
|
# request as needed.
|
4022
|
+
#
|
4023
|
+
# * **FAILED** -- GameLift is not able to complete the process of
|
4024
|
+
# placing the game session. Common reasons are the game session
|
4025
|
+
# terminated before the placement process was completed, or an
|
4026
|
+
# unexpected internal error.
|
3794
4027
|
# @return [String]
|
3795
4028
|
#
|
3796
4029
|
# @!attribute [rw] game_properties
|
@@ -3805,17 +4038,17 @@ module Aws::GameLift
|
|
3805
4038
|
# @return [Array<Types::GameProperty>]
|
3806
4039
|
#
|
3807
4040
|
# @!attribute [rw] maximum_player_session_count
|
3808
|
-
#
|
3809
|
-
# the game session.
|
4041
|
+
# The maximum number of players that can be connected simultaneously
|
4042
|
+
# to the game session.
|
3810
4043
|
# @return [Integer]
|
3811
4044
|
#
|
3812
4045
|
# @!attribute [rw] game_session_name
|
3813
|
-
#
|
4046
|
+
# A descriptive label that is associated with a game session. Session
|
3814
4047
|
# names do not need to be unique.
|
3815
4048
|
# @return [String]
|
3816
4049
|
#
|
3817
4050
|
# @!attribute [rw] game_session_id
|
3818
|
-
#
|
4051
|
+
# A unique identifier for the game session. This value is set once the
|
3819
4052
|
# new game session is placed (placement status is `FULFILLED`).
|
3820
4053
|
# @return [String]
|
3821
4054
|
#
|
@@ -3823,19 +4056,19 @@ module Aws::GameLift
|
|
3823
4056
|
# Identifier for the game session created by this placement request.
|
3824
4057
|
# This value is set once the new game session is placed (placement
|
3825
4058
|
# status is `FULFILLED`). This identifier is unique across all
|
3826
|
-
#
|
4059
|
+
# Regions. You can use this value as a `GameSessionId` value as
|
3827
4060
|
# needed.
|
3828
4061
|
# @return [String]
|
3829
4062
|
#
|
3830
4063
|
# @!attribute [rw] game_session_region
|
3831
|
-
# Name of the
|
4064
|
+
# Name of the Region where the game session created by this placement
|
3832
4065
|
# request is running. This value is set once the new game session is
|
3833
4066
|
# placed (placement status is `FULFILLED`).
|
3834
4067
|
# @return [String]
|
3835
4068
|
#
|
3836
4069
|
# @!attribute [rw] player_latencies
|
3837
4070
|
# Set of values, expressed in milliseconds, indicating the amount of
|
3838
|
-
# latency that a player experiences when connected to AWS
|
4071
|
+
# latency that a player experiences when connected to AWS Regions.
|
3839
4072
|
# @return [Array<Types::PlayerLatency>]
|
3840
4073
|
#
|
3841
4074
|
# @!attribute [rw] start_time
|
@@ -3850,13 +4083,30 @@ module Aws::GameLift
|
|
3850
4083
|
# @return [Time]
|
3851
4084
|
#
|
3852
4085
|
# @!attribute [rw] ip_address
|
3853
|
-
# IP address of the
|
3854
|
-
#
|
3855
|
-
#
|
4086
|
+
# IP address of the instance that is running the game session. When
|
4087
|
+
# connecting to a Amazon GameLift game server, a client needs to
|
4088
|
+
# reference an IP address (or DNS name) and port number. This value is
|
4089
|
+
# set once the new game session is placed (placement status is
|
3856
4090
|
# `FULFILLED`).
|
3857
4091
|
# @return [String]
|
3858
4092
|
#
|
3859
4093
|
# @!attribute [rw] dns_name
|
4094
|
+
# DNS identifier assigned to the instance that is running the game
|
4095
|
+
# session. Values have the following format:
|
4096
|
+
#
|
4097
|
+
# * TLS-enabled fleets: `<unique identifier>.<region
|
4098
|
+
# identifier>.amazongamelift.com`.
|
4099
|
+
#
|
4100
|
+
# * Non-TLS-enabled fleets: `ec2-<unique
|
4101
|
+
# identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP
|
4102
|
+
# Addressing][1].)
|
4103
|
+
#
|
4104
|
+
# When connecting to a game session that is running on a TLS-enabled
|
4105
|
+
# fleet, you must use the DNS name, not the IP address.
|
4106
|
+
#
|
4107
|
+
#
|
4108
|
+
#
|
4109
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
|
3860
4110
|
# @return [String]
|
3861
4111
|
#
|
3862
4112
|
# @!attribute [rw] port
|
@@ -3867,8 +4117,8 @@ module Aws::GameLift
|
|
3867
4117
|
# @return [Integer]
|
3868
4118
|
#
|
3869
4119
|
# @!attribute [rw] placed_player_sessions
|
3870
|
-
#
|
3871
|
-
# the game session placement request. These player sessions are
|
4120
|
+
# A collection of information on player sessions created in response
|
4121
|
+
# to the game session placement request. These player sessions are
|
3872
4122
|
# created only once a new game session is successfully placed
|
3873
4123
|
# (placement status is `FULFILLED`). This information includes the
|
3874
4124
|
# player ID (as provided in the placement request) and the
|
@@ -3953,41 +4203,42 @@ module Aws::GameLift
|
|
3953
4203
|
# * DeleteGameSessionQueue
|
3954
4204
|
#
|
3955
4205
|
# @!attribute [rw] name
|
3956
|
-
#
|
3957
|
-
# names must be unique within each
|
4206
|
+
# A descriptive label that is associated with game session queue.
|
4207
|
+
# Queue names must be unique within each Region.
|
3958
4208
|
# @return [String]
|
3959
4209
|
#
|
3960
4210
|
# @!attribute [rw] game_session_queue_arn
|
3961
|
-
# Amazon Resource Name ([ARN][1]) that is assigned to a game
|
3962
|
-
# queue and uniquely identifies it.
|
3963
|
-
#
|
3964
|
-
#
|
4211
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
4212
|
+
# session queue resource and uniquely identifies it. ARNs are unique
|
4213
|
+
# across all Regions. In a GameLift game session queue ARN, the
|
4214
|
+
# resource ID matches the *Name* value.
|
3965
4215
|
#
|
3966
4216
|
#
|
3967
4217
|
#
|
3968
|
-
# [1]: https://docs.aws.amazon.com/
|
4218
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3969
4219
|
# @return [String]
|
3970
4220
|
#
|
3971
4221
|
# @!attribute [rw] timeout_in_seconds
|
3972
|
-
#
|
3973
|
-
# remains in the queue. When a request exceeds this time, the
|
3974
|
-
# session placement changes to a `TIMED_OUT` status.
|
4222
|
+
# The maximum time, in seconds, that a new game session placement
|
4223
|
+
# request remains in the queue. When a request exceeds this time, the
|
4224
|
+
# game session placement changes to a `TIMED_OUT` status.
|
3975
4225
|
# @return [Integer]
|
3976
4226
|
#
|
3977
4227
|
# @!attribute [rw] player_latency_policies
|
3978
|
-
#
|
4228
|
+
# A collection of latency policies to apply when processing game
|
3979
4229
|
# sessions placement requests with player latency information.
|
3980
4230
|
# Multiple policies are evaluated in order of the maximum latency
|
3981
4231
|
# value, starting with the lowest latency values. With just one
|
3982
|
-
# policy,
|
3983
|
-
# for the duration period. With multiple policies, each
|
3984
|
-
# enforced consecutively for its duration period. For
|
3985
|
-
# might enforce a 60-second policy followed by a
|
3986
|
-
# and then no policy for the remainder of the
|
4232
|
+
# policy, the policy is enforced at the start of the game session
|
4233
|
+
# placement for the duration period. With multiple policies, each
|
4234
|
+
# policy is enforced consecutively for its duration period. For
|
4235
|
+
# example, a queue might enforce a 60-second policy followed by a
|
4236
|
+
# 120-second policy, and then no policy for the remainder of the
|
4237
|
+
# placement.
|
3987
4238
|
# @return [Array<Types::PlayerLatencyPolicy>]
|
3988
4239
|
#
|
3989
4240
|
# @!attribute [rw] destinations
|
3990
|
-
#
|
4241
|
+
# A list of fleets that can be used to fulfill game session placement
|
3991
4242
|
# requests in the queue. Fleets are identified by either a fleet ARN
|
3992
4243
|
# or a fleet alias ARN. Destinations are listed in default preference
|
3993
4244
|
# order.
|
@@ -4006,7 +4257,7 @@ module Aws::GameLift
|
|
4006
4257
|
|
4007
4258
|
# Fleet designated in a game session queue. Requests for new game
|
4008
4259
|
# sessions in the queue are fulfilled by starting a new game session on
|
4009
|
-
# any destination configured for a queue.
|
4260
|
+
# any destination that is configured for a queue.
|
4010
4261
|
#
|
4011
4262
|
# * CreateGameSessionQueue
|
4012
4263
|
#
|
@@ -4024,9 +4275,9 @@ module Aws::GameLift
|
|
4024
4275
|
# }
|
4025
4276
|
#
|
4026
4277
|
# @!attribute [rw] destination_arn
|
4027
|
-
# Amazon Resource Name (ARN) assigned to fleet or fleet
|
4028
|
-
# which include a fleet ID or alias ID and a
|
4029
|
-
# unique identifier across all
|
4278
|
+
# The Amazon Resource Name (ARN) that is assigned to fleet or fleet
|
4279
|
+
# alias. ARNs, which include a fleet ID or alias ID and a Region name,
|
4280
|
+
# provide a unique identifier across all Regions.
|
4030
4281
|
# @return [String]
|
4031
4282
|
#
|
4032
4283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionQueueDestination AWS API Documentation
|
@@ -4046,7 +4297,7 @@ module Aws::GameLift
|
|
4046
4297
|
# }
|
4047
4298
|
#
|
4048
4299
|
# @!attribute [rw] game_session_id
|
4049
|
-
#
|
4300
|
+
# A unique identifier for the game session to get logs for.
|
4050
4301
|
# @return [String]
|
4051
4302
|
#
|
4052
4303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetGameSessionLogUrlInput AWS API Documentation
|
@@ -4083,15 +4334,16 @@ module Aws::GameLift
|
|
4083
4334
|
# }
|
4084
4335
|
#
|
4085
4336
|
# @!attribute [rw] fleet_id
|
4086
|
-
#
|
4087
|
-
# access to.
|
4088
|
-
#
|
4089
|
-
# may be accessible for a short
|
4337
|
+
# A unique identifier for a fleet that contains the instance you want
|
4338
|
+
# access to. You can use either the fleet ID or ARN value. The fleet
|
4339
|
+
# can be in any of the following statuses: `ACTIVATING`, `ACTIVE`, or
|
4340
|
+
# `ERROR`. Fleets with an `ERROR` status may be accessible for a short
|
4341
|
+
# time before they are deleted.
|
4090
4342
|
# @return [String]
|
4091
4343
|
#
|
4092
4344
|
# @!attribute [rw] instance_id
|
4093
|
-
#
|
4094
|
-
# access an instance in any status.
|
4345
|
+
# A unique identifier for an instance you want to get access to. You
|
4346
|
+
# can access an instance in any status.
|
4095
4347
|
# @return [String]
|
4096
4348
|
#
|
4097
4349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetInstanceAccessInput AWS API Documentation
|
@@ -4105,8 +4357,8 @@ module Aws::GameLift
|
|
4105
4357
|
# Represents the returned data in response to a request action.
|
4106
4358
|
#
|
4107
4359
|
# @!attribute [rw] instance_access
|
4108
|
-
#
|
4109
|
-
#
|
4360
|
+
# The connection information for a fleet instance, including IP
|
4361
|
+
# address and access credentials.
|
4110
4362
|
# @return [Types::InstanceAccess]
|
4111
4363
|
#
|
4112
4364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetInstanceAccessOutput AWS API Documentation
|
@@ -4134,18 +4386,34 @@ module Aws::GameLift
|
|
4134
4386
|
# instances.
|
4135
4387
|
#
|
4136
4388
|
# @!attribute [rw] fleet_id
|
4137
|
-
#
|
4389
|
+
# A unique identifier for a fleet that the instance is in.
|
4138
4390
|
# @return [String]
|
4139
4391
|
#
|
4140
4392
|
# @!attribute [rw] instance_id
|
4141
|
-
#
|
4393
|
+
# A unique identifier for an instance.
|
4142
4394
|
# @return [String]
|
4143
4395
|
#
|
4144
4396
|
# @!attribute [rw] ip_address
|
4145
|
-
# IP address assigned to the instance.
|
4397
|
+
# IP address that is assigned to the instance.
|
4146
4398
|
# @return [String]
|
4147
4399
|
#
|
4148
4400
|
# @!attribute [rw] dns_name
|
4401
|
+
# DNS identifier assigned to the instance that is running the game
|
4402
|
+
# session. Values have the following format:
|
4403
|
+
#
|
4404
|
+
# * TLS-enabled fleets: `<unique identifier>.<region
|
4405
|
+
# identifier>.amazongamelift.com`.
|
4406
|
+
#
|
4407
|
+
# * Non-TLS-enabled fleets: `ec2-<unique
|
4408
|
+
# identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP
|
4409
|
+
# Addressing][1].)
|
4410
|
+
#
|
4411
|
+
# When connecting to a game session that is running on a TLS-enabled
|
4412
|
+
# fleet, you must use the DNS name, not the IP address.
|
4413
|
+
#
|
4414
|
+
#
|
4415
|
+
#
|
4416
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
|
4149
4417
|
# @return [String]
|
4150
4418
|
#
|
4151
4419
|
# @!attribute [rw] operating_system
|
@@ -4199,16 +4467,16 @@ module Aws::GameLift
|
|
4199
4467
|
# is requested by calling GetInstanceAccess.
|
4200
4468
|
#
|
4201
4469
|
# @!attribute [rw] fleet_id
|
4202
|
-
#
|
4470
|
+
# A unique identifier for a fleet containing the instance being
|
4203
4471
|
# accessed.
|
4204
4472
|
# @return [String]
|
4205
4473
|
#
|
4206
4474
|
# @!attribute [rw] instance_id
|
4207
|
-
#
|
4475
|
+
# A unique identifier for an instance being accessed.
|
4208
4476
|
# @return [String]
|
4209
4477
|
#
|
4210
4478
|
# @!attribute [rw] ip_address
|
4211
|
-
# IP address assigned to the instance.
|
4479
|
+
# IP address that is assigned to the instance.
|
4212
4480
|
# @return [String]
|
4213
4481
|
#
|
4214
4482
|
# @!attribute [rw] operating_system
|
@@ -4308,13 +4576,13 @@ module Aws::GameLift
|
|
4308
4576
|
end
|
4309
4577
|
|
4310
4578
|
# A range of IP addresses and port settings that allow inbound traffic
|
4311
|
-
# to connect to server processes on an Amazon GameLift
|
4312
|
-
# sessions that are started on the fleet are assigned an IP
|
4313
|
-
# number combination, which must fall into the fleet's
|
4314
|
-
# For fleets created with a custom game server, the
|
4315
|
-
# server's game session assignments. For Realtime
|
4316
|
-
# Amazon GameLift automatically opens two port ranges,
|
4317
|
-
# messaging and one for UDP for use by the Realtime servers.
|
4579
|
+
# to connect to server processes on an Amazon GameLift hosting resource.
|
4580
|
+
# New game sessions that are started on the fleet are assigned an IP
|
4581
|
+
# address/port number combination, which must fall into the fleet's
|
4582
|
+
# allowed ranges. For fleets created with a custom game server, the
|
4583
|
+
# ranges reflect the server's game session assignments. For Realtime
|
4584
|
+
# Servers fleets, Amazon GameLift automatically opens two port ranges,
|
4585
|
+
# one for TCP messaging and one for UDP for use by the Realtime servers.
|
4318
4586
|
#
|
4319
4587
|
# @note When making an API call, you may pass IpPermission
|
4320
4588
|
# data as a hash:
|
@@ -4327,22 +4595,22 @@ module Aws::GameLift
|
|
4327
4595
|
# }
|
4328
4596
|
#
|
4329
4597
|
# @!attribute [rw] from_port
|
4330
|
-
#
|
4598
|
+
# A starting value for a range of allowed port numbers.
|
4331
4599
|
# @return [Integer]
|
4332
4600
|
#
|
4333
4601
|
# @!attribute [rw] to_port
|
4334
|
-
#
|
4335
|
-
# end-inclusive. This value must be higher than `FromPort`.
|
4602
|
+
# An ending value for a range of allowed port numbers. Port numbers
|
4603
|
+
# are end-inclusive. This value must be higher than `FromPort`.
|
4336
4604
|
# @return [Integer]
|
4337
4605
|
#
|
4338
4606
|
# @!attribute [rw] ip_range
|
4339
|
-
#
|
4340
|
-
# notation. Example: "`000.000.000.000/[subnet mask]`" or
|
4341
|
-
# the shortened version "`0.0.0.0/[subnet mask]`".
|
4607
|
+
# A range of allowed IP addresses. This value must be expressed in
|
4608
|
+
# CIDR notation. Example: "`000.000.000.000/[subnet mask]`" or
|
4609
|
+
# optionally the shortened version "`0.0.0.0/[subnet mask]`".
|
4342
4610
|
# @return [String]
|
4343
4611
|
#
|
4344
4612
|
# @!attribute [rw] protocol
|
4345
|
-
#
|
4613
|
+
# The network communication protocol used by the fleet.
|
4346
4614
|
# @return [String]
|
4347
4615
|
#
|
4348
4616
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/IpPermission AWS API Documentation
|
@@ -4381,9 +4649,9 @@ module Aws::GameLift
|
|
4381
4649
|
# }
|
4382
4650
|
#
|
4383
4651
|
# @!attribute [rw] routing_strategy_type
|
4384
|
-
#
|
4385
|
-
# only aliases
|
4386
|
-
# parameter empty.
|
4652
|
+
# The routing type to filter results on. Use this parameter to
|
4653
|
+
# retrieve only aliases with a certain routing type. To retrieve all
|
4654
|
+
# aliases, leave this parameter empty.
|
4387
4655
|
#
|
4388
4656
|
# Possible routing types include the following:
|
4389
4657
|
#
|
@@ -4397,17 +4665,17 @@ module Aws::GameLift
|
|
4397
4665
|
# @return [String]
|
4398
4666
|
#
|
4399
4667
|
# @!attribute [rw] name
|
4400
|
-
#
|
4668
|
+
# A descriptive label that is associated with an alias. Alias names do
|
4401
4669
|
# not need to be unique.
|
4402
4670
|
# @return [String]
|
4403
4671
|
#
|
4404
4672
|
# @!attribute [rw] limit
|
4405
|
-
#
|
4673
|
+
# The maximum number of results to return. Use this parameter with
|
4406
4674
|
# `NextToken` to get results as a set of sequential pages.
|
4407
4675
|
# @return [Integer]
|
4408
4676
|
#
|
4409
4677
|
# @!attribute [rw] next_token
|
4410
|
-
#
|
4678
|
+
# A token that indicates the start of the next sequential page of
|
4411
4679
|
# results. Use the token that is returned with a previous call to this
|
4412
4680
|
# action. To start at the beginning of the result set, do not specify
|
4413
4681
|
# a value.
|
@@ -4426,12 +4694,12 @@ module Aws::GameLift
|
|
4426
4694
|
# Represents the returned data in response to a request action.
|
4427
4695
|
#
|
4428
4696
|
# @!attribute [rw] aliases
|
4429
|
-
#
|
4697
|
+
# A collection of alias resources that match the request parameters.
|
4430
4698
|
# @return [Array<Types::Alias>]
|
4431
4699
|
#
|
4432
4700
|
# @!attribute [rw] next_token
|
4433
|
-
#
|
4434
|
-
# call to this action. If no token is returned, these results
|
4701
|
+
# A token that indicates where to resume retrieving results on the
|
4702
|
+
# next call to this action. If no token is returned, these results
|
4435
4703
|
# represent the end of the list.
|
4436
4704
|
# @return [String]
|
4437
4705
|
#
|
@@ -4473,7 +4741,7 @@ module Aws::GameLift
|
|
4473
4741
|
# @return [String]
|
4474
4742
|
#
|
4475
4743
|
# @!attribute [rw] limit
|
4476
|
-
#
|
4744
|
+
# The maximum number of results to return. Use this parameter with
|
4477
4745
|
# `NextToken` to get results as a set of sequential pages.
|
4478
4746
|
# @return [Integer]
|
4479
4747
|
#
|
@@ -4496,7 +4764,7 @@ module Aws::GameLift
|
|
4496
4764
|
# Represents the returned data in response to a request action.
|
4497
4765
|
#
|
4498
4766
|
# @!attribute [rw] builds
|
4499
|
-
#
|
4767
|
+
# A collection of build records that match the request.
|
4500
4768
|
# @return [Array<Types::Build>]
|
4501
4769
|
#
|
4502
4770
|
# @!attribute [rw] next_token
|
@@ -4526,19 +4794,21 @@ module Aws::GameLift
|
|
4526
4794
|
# }
|
4527
4795
|
#
|
4528
4796
|
# @!attribute [rw] build_id
|
4529
|
-
#
|
4530
|
-
# parameter to return only fleets using the specified build.
|
4531
|
-
# retrieve all fleets, leave this
|
4797
|
+
# A unique identifier for a build to return fleets for. Use this
|
4798
|
+
# parameter to return only fleets using the specified build. Use
|
4799
|
+
# either the build ID or ARN value.To retrieve all fleets, leave this
|
4800
|
+
# parameter empty.
|
4532
4801
|
# @return [String]
|
4533
4802
|
#
|
4534
4803
|
# @!attribute [rw] script_id
|
4535
|
-
#
|
4536
|
-
# this parameter to return only fleets using the specified script.
|
4537
|
-
# retrieve all fleets, leave this
|
4804
|
+
# A unique identifier for a Realtime script to return fleets for. Use
|
4805
|
+
# this parameter to return only fleets using the specified script. Use
|
4806
|
+
# either the script ID or ARN value.To retrieve all fleets, leave this
|
4807
|
+
# parameter empty.
|
4538
4808
|
# @return [String]
|
4539
4809
|
#
|
4540
4810
|
# @!attribute [rw] limit
|
4541
|
-
#
|
4811
|
+
# The maximum number of results to return. Use this parameter with
|
4542
4812
|
# `NextToken` to get results as a set of sequential pages.
|
4543
4813
|
# @return [Integer]
|
4544
4814
|
#
|
@@ -4591,12 +4861,12 @@ module Aws::GameLift
|
|
4591
4861
|
# }
|
4592
4862
|
#
|
4593
4863
|
# @!attribute [rw] limit
|
4594
|
-
#
|
4864
|
+
# The maximum number of results to return. Use this parameter with
|
4595
4865
|
# `NextToken` to get results as a set of sequential pages.
|
4596
4866
|
# @return [Integer]
|
4597
4867
|
#
|
4598
4868
|
# @!attribute [rw] next_token
|
4599
|
-
#
|
4869
|
+
# A token that indicates the start of the next sequential page of
|
4600
4870
|
# results. Use the token that is returned with a previous call to this
|
4601
4871
|
# action. To start at the beginning of the result set, do not specify
|
4602
4872
|
# a value.
|
@@ -4611,12 +4881,12 @@ module Aws::GameLift
|
|
4611
4881
|
end
|
4612
4882
|
|
4613
4883
|
# @!attribute [rw] scripts
|
4614
|
-
#
|
4884
|
+
# A set of properties describing the requested script.
|
4615
4885
|
# @return [Array<Types::Script>]
|
4616
4886
|
#
|
4617
4887
|
# @!attribute [rw] next_token
|
4618
|
-
#
|
4619
|
-
# call to this action. If no token is returned, these results
|
4888
|
+
# A token that indicates where to resume retrieving results on the
|
4889
|
+
# next call to this action. If no token is returned, these results
|
4620
4890
|
# represent the end of the list.
|
4621
4891
|
# @return [String]
|
4622
4892
|
#
|
@@ -4628,6 +4898,44 @@ module Aws::GameLift
|
|
4628
4898
|
include Aws::Structure
|
4629
4899
|
end
|
4630
4900
|
|
4901
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4902
|
+
# data as a hash:
|
4903
|
+
#
|
4904
|
+
# {
|
4905
|
+
# resource_arn: "AmazonResourceName", # required
|
4906
|
+
# }
|
4907
|
+
#
|
4908
|
+
# @!attribute [rw] resource_arn
|
4909
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
4910
|
+
# identifies the GameLift resource that you want to retrieve tags for.
|
4911
|
+
# GameLift resource ARNs are included in the data object for the
|
4912
|
+
# resource, which can be retrieved by calling a List or Describe
|
4913
|
+
# action for the resource type.
|
4914
|
+
#
|
4915
|
+
#
|
4916
|
+
#
|
4917
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
4918
|
+
# @return [String]
|
4919
|
+
#
|
4920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListTagsForResourceRequest AWS API Documentation
|
4921
|
+
#
|
4922
|
+
class ListTagsForResourceRequest < Struct.new(
|
4923
|
+
:resource_arn)
|
4924
|
+
include Aws::Structure
|
4925
|
+
end
|
4926
|
+
|
4927
|
+
# @!attribute [rw] tags
|
4928
|
+
# The collection of tags that have been assigned to the specified
|
4929
|
+
# resource.
|
4930
|
+
# @return [Array<Types::Tag>]
|
4931
|
+
#
|
4932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListTagsForResourceResponse AWS API Documentation
|
4933
|
+
#
|
4934
|
+
class ListTagsForResourceResponse < Struct.new(
|
4935
|
+
:tags)
|
4936
|
+
include Aws::Structure
|
4937
|
+
end
|
4938
|
+
|
4631
4939
|
# Represents a new player session that is created as a result of a
|
4632
4940
|
# successful FlexMatch match. A successful match automatically creates
|
4633
4941
|
# new player sessions for every player ID in the original matchmaking
|
@@ -4638,11 +4946,11 @@ module Aws::GameLift
|
|
4638
4946
|
# player slot.
|
4639
4947
|
#
|
4640
4948
|
# @!attribute [rw] player_id
|
4641
|
-
#
|
4949
|
+
# A unique identifier for a player
|
4642
4950
|
# @return [String]
|
4643
4951
|
#
|
4644
4952
|
# @!attribute [rw] player_session_id
|
4645
|
-
#
|
4953
|
+
# A unique identifier for a player session
|
4646
4954
|
# @return [String]
|
4647
4955
|
#
|
4648
4956
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchedPlayerSession AWS API Documentation
|
@@ -4657,61 +4965,84 @@ module Aws::GameLift
|
|
4657
4965
|
# matchmaking requests must specify a matchmaking configuration.
|
4658
4966
|
#
|
4659
4967
|
# @!attribute [rw] name
|
4660
|
-
#
|
4661
|
-
# to identify the configuration associated with a matchmaking
|
4662
|
-
# or ticket.
|
4968
|
+
# A unique identifier for a matchmaking configuration. This name is
|
4969
|
+
# used to identify the configuration associated with a matchmaking
|
4970
|
+
# request or ticket.
|
4971
|
+
# @return [String]
|
4972
|
+
#
|
4973
|
+
# @!attribute [rw] configuration_arn
|
4974
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift
|
4975
|
+
# matchmaking configuration resource and uniquely identifies it. ARNs
|
4976
|
+
# are unique across all Regions. In a GameLift configuration ARN, the
|
4977
|
+
# resource ID matches the *Name* value.
|
4978
|
+
#
|
4979
|
+
#
|
4980
|
+
#
|
4981
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
4663
4982
|
# @return [String]
|
4664
4983
|
#
|
4665
4984
|
# @!attribute [rw] description
|
4666
|
-
#
|
4985
|
+
# A descriptive label that is associated with matchmaking
|
4986
|
+
# configuration.
|
4667
4987
|
# @return [String]
|
4668
4988
|
#
|
4669
4989
|
# @!attribute [rw] game_session_queue_arns
|
4670
|
-
# Amazon Resource Name ([ARN][1]) that is assigned to a game
|
4671
|
-
# queue and uniquely identifies it.
|
4672
|
-
#
|
4673
|
-
#
|
4674
|
-
#
|
4675
|
-
# located in any region.
|
4990
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
4991
|
+
# session queue resource and uniquely identifies it. ARNs are unique
|
4992
|
+
# across all Regions. GameLift uses the listed queues when placing
|
4993
|
+
# game sessions for matches that are created with this matchmaking
|
4994
|
+
# configuration. Queues can be located in any Region.
|
4676
4995
|
#
|
4677
4996
|
#
|
4678
4997
|
#
|
4679
|
-
# [1]: https://docs.aws.amazon.com/
|
4998
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
4680
4999
|
# @return [Array<String>]
|
4681
5000
|
#
|
4682
5001
|
# @!attribute [rw] request_timeout_seconds
|
4683
|
-
#
|
4684
|
-
# in process before timing out. Requests that fail due to
|
4685
|
-
# can be resubmitted as needed.
|
5002
|
+
# The maximum duration, in seconds, that a matchmaking ticket can
|
5003
|
+
# remain in process before timing out. Requests that fail due to
|
5004
|
+
# timing out can be resubmitted as needed.
|
4686
5005
|
# @return [Integer]
|
4687
5006
|
#
|
4688
5007
|
# @!attribute [rw] acceptance_timeout_seconds
|
4689
|
-
#
|
4690
|
-
# match. If any player rejects the match or fails to accept
|
4691
|
-
# timeout, the ticket continues to look for an acceptable
|
5008
|
+
# The length of time (in seconds) to wait for players to accept a
|
5009
|
+
# proposed match. If any player rejects the match or fails to accept
|
5010
|
+
# before the timeout, the ticket continues to look for an acceptable
|
5011
|
+
# match.
|
4692
5012
|
# @return [Integer]
|
4693
5013
|
#
|
4694
5014
|
# @!attribute [rw] acceptance_required
|
4695
|
-
#
|
5015
|
+
# A flag that indicates whether a match that was created with this
|
4696
5016
|
# configuration must be accepted by the matched players. To require
|
4697
5017
|
# acceptance, set to TRUE.
|
4698
5018
|
# @return [Boolean]
|
4699
5019
|
#
|
4700
5020
|
# @!attribute [rw] rule_set_name
|
4701
|
-
#
|
5021
|
+
# A unique identifier for a matchmaking rule set to use with this
|
4702
5022
|
# configuration. A matchmaking configuration can only use rule sets
|
4703
|
-
# that are defined in the same
|
5023
|
+
# that are defined in the same Region.
|
5024
|
+
# @return [String]
|
5025
|
+
#
|
5026
|
+
# @!attribute [rw] rule_set_arn
|
5027
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
5028
|
+
# matchmaking rule set resource that this configuration uses.
|
5029
|
+
#
|
5030
|
+
#
|
5031
|
+
#
|
5032
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
4704
5033
|
# @return [String]
|
4705
5034
|
#
|
4706
5035
|
# @!attribute [rw] notification_target
|
4707
|
-
# SNS topic ARN that is set up to receive matchmaking
|
5036
|
+
# An SNS topic ARN that is set up to receive matchmaking
|
5037
|
+
# notifications.
|
4708
5038
|
# @return [String]
|
4709
5039
|
#
|
4710
5040
|
# @!attribute [rw] additional_player_count
|
4711
|
-
#
|
4712
|
-
# For example,
|
4713
|
-
# a single 12-person team
|
4714
|
-
# 2, only 10 players are selected for
|
5041
|
+
# The number of player slots in a match to keep open for future
|
5042
|
+
# players. For example, assume that the configuration's rule set
|
5043
|
+
# specifies a match for a single 12-person team. If the additional
|
5044
|
+
# player count is set to 2, only 10 players are initially selected for
|
5045
|
+
# the match.
|
4715
5046
|
# @return [Integer]
|
4716
5047
|
#
|
4717
5048
|
# @!attribute [rw] custom_event_data
|
@@ -4720,17 +5051,18 @@ module Aws::GameLift
|
|
4720
5051
|
# @return [String]
|
4721
5052
|
#
|
4722
5053
|
# @!attribute [rw] creation_time
|
4723
|
-
#
|
4724
|
-
# number expressed in Unix time as milliseconds (for
|
4725
|
-
# "1469498468.057").
|
5054
|
+
# The time stamp indicating when this data object was created. The
|
5055
|
+
# format is a number expressed in Unix time as milliseconds (for
|
5056
|
+
# example "1469498468.057").
|
4726
5057
|
# @return [Time]
|
4727
5058
|
#
|
4728
5059
|
# @!attribute [rw] game_properties
|
4729
|
-
#
|
4730
|
-
# pairs. These properties are passed to a game server
|
4731
|
-
# GameSession object with a request to start a new game
|
4732
|
-
# [Start a Game Session][1]). This information is added
|
4733
|
-
# GameSession object that is created for a successful
|
5060
|
+
# A set of custom properties for a game session, formatted as
|
5061
|
+
# key-value pairs. These properties are passed to a game server
|
5062
|
+
# process in the GameSession object with a request to start a new game
|
5063
|
+
# session (see [Start a Game Session][1]). This information is added
|
5064
|
+
# to the new GameSession object that is created for a successful
|
5065
|
+
# match.
|
4734
5066
|
#
|
4735
5067
|
#
|
4736
5068
|
#
|
@@ -4738,8 +5070,8 @@ module Aws::GameLift
|
|
4738
5070
|
# @return [Array<Types::GameProperty>]
|
4739
5071
|
#
|
4740
5072
|
# @!attribute [rw] game_session_data
|
4741
|
-
#
|
4742
|
-
# value. This data is passed to a game server process in the
|
5073
|
+
# A set of custom game session properties, formatted as a single
|
5074
|
+
# string value. This data is passed to a game server process in the
|
4743
5075
|
# GameSession object with a request to start a new game session (see
|
4744
5076
|
# [Start a Game Session][1]). This information is added to the new
|
4745
5077
|
# GameSession object that is created for a successful match.
|
@@ -4750,13 +5082,13 @@ module Aws::GameLift
|
|
4750
5082
|
# @return [String]
|
4751
5083
|
#
|
4752
5084
|
# @!attribute [rw] backfill_mode
|
4753
|
-
#
|
4754
|
-
# configuration. MANUAL indicates that the game makes
|
4755
|
-
# requests or does not use the match backfill feature.
|
4756
|
-
# indicates that GameLift creates StartMatchBackfill
|
4757
|
-
# a game session has one or more open slots. Learn
|
4758
|
-
# and automatic backfill in [Backfill Existing Games
|
4759
|
-
# FlexMatch][1].
|
5085
|
+
# The method used to backfill game sessions created with this
|
5086
|
+
# matchmaking configuration. MANUAL indicates that the game makes
|
5087
|
+
# backfill requests or does not use the match backfill feature.
|
5088
|
+
# AUTOMATIC indicates that GameLift creates StartMatchBackfill
|
5089
|
+
# requests whenever a game session has one or more open slots. Learn
|
5090
|
+
# more about manual and automatic backfill in [Backfill Existing Games
|
5091
|
+
# with FlexMatch][1].
|
4760
5092
|
#
|
4761
5093
|
#
|
4762
5094
|
#
|
@@ -4767,12 +5099,14 @@ module Aws::GameLift
|
|
4767
5099
|
#
|
4768
5100
|
class MatchmakingConfiguration < Struct.new(
|
4769
5101
|
:name,
|
5102
|
+
:configuration_arn,
|
4770
5103
|
:description,
|
4771
5104
|
:game_session_queue_arns,
|
4772
5105
|
:request_timeout_seconds,
|
4773
5106
|
:acceptance_timeout_seconds,
|
4774
5107
|
:acceptance_required,
|
4775
5108
|
:rule_set_name,
|
5109
|
+
:rule_set_arn,
|
4776
5110
|
:notification_target,
|
4777
5111
|
:additional_player_count,
|
4778
5112
|
:custom_event_data,
|
@@ -4824,25 +5158,37 @@ module Aws::GameLift
|
|
4824
5158
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
|
4825
5159
|
#
|
4826
5160
|
# @!attribute [rw] rule_set_name
|
4827
|
-
#
|
5161
|
+
# A unique identifier for a matchmaking rule set
|
5162
|
+
# @return [String]
|
5163
|
+
#
|
5164
|
+
# @!attribute [rw] rule_set_arn
|
5165
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift
|
5166
|
+
# matchmaking rule set resource and uniquely identifies it. ARNs are
|
5167
|
+
# unique across all Regions. In a GameLift rule set ARN, the resource
|
5168
|
+
# ID matches the *RuleSetName* value.
|
5169
|
+
#
|
5170
|
+
#
|
5171
|
+
#
|
5172
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
4828
5173
|
# @return [String]
|
4829
5174
|
#
|
4830
5175
|
# @!attribute [rw] rule_set_body
|
4831
|
-
#
|
5176
|
+
# A collection of matchmaking rules, formatted as a JSON string.
|
4832
5177
|
# Comments are not allowed in JSON, but most elements support a
|
4833
5178
|
# description field.
|
4834
5179
|
# @return [String]
|
4835
5180
|
#
|
4836
5181
|
# @!attribute [rw] creation_time
|
4837
|
-
#
|
4838
|
-
# number expressed in Unix time as milliseconds (for
|
4839
|
-
# "1469498468.057").
|
5182
|
+
# The time stamp indicating when this data object was created. The
|
5183
|
+
# format is a number expressed in Unix time as milliseconds (for
|
5184
|
+
# example "1469498468.057").
|
4840
5185
|
# @return [Time]
|
4841
5186
|
#
|
4842
5187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchmakingRuleSet AWS API Documentation
|
4843
5188
|
#
|
4844
5189
|
class MatchmakingRuleSet < Struct.new(
|
4845
5190
|
:rule_set_name,
|
5191
|
+
:rule_set_arn,
|
4846
5192
|
:rule_set_body,
|
4847
5193
|
:creation_time)
|
4848
5194
|
include Aws::Structure
|
@@ -4855,7 +5201,7 @@ module Aws::GameLift
|
|
4855
5201
|
# ticket ID.
|
4856
5202
|
#
|
4857
5203
|
# @!attribute [rw] ticket_id
|
4858
|
-
#
|
5204
|
+
# A unique identifier for a matchmaking ticket.
|
4859
5205
|
# @return [String]
|
4860
5206
|
#
|
4861
5207
|
# @!attribute [rw] configuration_name
|
@@ -4864,6 +5210,15 @@ module Aws::GameLift
|
|
4864
5210
|
# match and how a new game session is created for the match.
|
4865
5211
|
# @return [String]
|
4866
5212
|
#
|
5213
|
+
# @!attribute [rw] configuration_arn
|
5214
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
5215
|
+
# matchmaking configuration resource that is used with this ticket.
|
5216
|
+
#
|
5217
|
+
#
|
5218
|
+
#
|
5219
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5220
|
+
# @return [String]
|
5221
|
+
#
|
4867
5222
|
# @!attribute [rw] status
|
4868
5223
|
# Current status of the matchmaking request.
|
4869
5224
|
#
|
@@ -4949,6 +5304,7 @@ module Aws::GameLift
|
|
4949
5304
|
class MatchmakingTicket < Struct.new(
|
4950
5305
|
:ticket_id,
|
4951
5306
|
:configuration_name,
|
5307
|
+
:configuration_arn,
|
4952
5308
|
:status,
|
4953
5309
|
:status_reason,
|
4954
5310
|
:status_message,
|
@@ -4993,12 +5349,12 @@ module Aws::GameLift
|
|
4993
5349
|
# * StopGameSessionPlacement
|
4994
5350
|
#
|
4995
5351
|
# @!attribute [rw] player_id
|
4996
|
-
#
|
5352
|
+
# A unique identifier for a player that is associated with this player
|
4997
5353
|
# session.
|
4998
5354
|
# @return [String]
|
4999
5355
|
#
|
5000
5356
|
# @!attribute [rw] player_session_id
|
5001
|
-
#
|
5357
|
+
# A unique identifier for a player session.
|
5002
5358
|
# @return [String]
|
5003
5359
|
#
|
5004
5360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PlacedPlayerSession AWS API Documentation
|
@@ -5029,12 +5385,12 @@ module Aws::GameLift
|
|
5029
5385
|
# }
|
5030
5386
|
#
|
5031
5387
|
# @!attribute [rw] player_id
|
5032
|
-
#
|
5388
|
+
# A unique identifier for a player
|
5033
5389
|
# @return [String]
|
5034
5390
|
#
|
5035
5391
|
# @!attribute [rw] player_attributes
|
5036
|
-
#
|
5037
|
-
# in matchmaking. Player attribute keys must match the
|
5392
|
+
# A collection of key:value pairs containing player information for
|
5393
|
+
# use in matchmaking. Player attribute keys must match the
|
5038
5394
|
# *playerAttributes* used in a matchmaking rule set. Example:
|
5039
5395
|
# `"PlayerAttributes": \{"skill": \{"N": "23"\}, "gameMode": \{"S":
|
5040
5396
|
# "deathmatch"\}\}`.
|
@@ -5047,13 +5403,13 @@ module Aws::GameLift
|
|
5047
5403
|
#
|
5048
5404
|
# @!attribute [rw] latency_in_ms
|
5049
5405
|
# Set of values, expressed in milliseconds, indicating the amount of
|
5050
|
-
# latency that a player experiences when connected to AWS
|
5406
|
+
# latency that a player experiences when connected to AWS Regions. If
|
5051
5407
|
# this property is present, FlexMatch considers placing the match only
|
5052
|
-
# in
|
5408
|
+
# in Regions for which latency is reported.
|
5053
5409
|
#
|
5054
5410
|
# If a matchmaker has a rule that evaluates player latency, players
|
5055
5411
|
# must report latency in order to be matched. If no latency is
|
5056
|
-
# reported in this scenario, FlexMatch assumes that no
|
5412
|
+
# reported in this scenario, FlexMatch assumes that no Regions are
|
5057
5413
|
# available to the player and the ticket is not matchable.
|
5058
5414
|
# @return [Hash<String,Integer>]
|
5059
5415
|
#
|
@@ -5070,8 +5426,8 @@ module Aws::GameLift
|
|
5070
5426
|
# Regional latency information for a player, used when requesting a new
|
5071
5427
|
# game session with StartGameSessionPlacement. This value indicates the
|
5072
5428
|
# amount of time lag that exists when the player is connected to a fleet
|
5073
|
-
# in the specified
|
5074
|
-
# latency values for multiple
|
5429
|
+
# in the specified Region. The relative difference between a player's
|
5430
|
+
# latency values for multiple Regions are used to determine which fleets
|
5075
5431
|
# are best suited to place a new game session for the player.
|
5076
5432
|
#
|
5077
5433
|
# @note When making an API call, you may pass PlayerLatency
|
@@ -5084,16 +5440,16 @@ module Aws::GameLift
|
|
5084
5440
|
# }
|
5085
5441
|
#
|
5086
5442
|
# @!attribute [rw] player_id
|
5087
|
-
#
|
5443
|
+
# A unique identifier for a player associated with the latency data.
|
5088
5444
|
# @return [String]
|
5089
5445
|
#
|
5090
5446
|
# @!attribute [rw] region_identifier
|
5091
|
-
# Name of the
|
5447
|
+
# Name of the Region that is associated with the latency value.
|
5092
5448
|
# @return [String]
|
5093
5449
|
#
|
5094
5450
|
# @!attribute [rw] latency_in_milliseconds
|
5095
5451
|
# Amount of time that represents the time lag experienced by the
|
5096
|
-
# player when connected to the specified
|
5452
|
+
# player when connected to the specified Region.
|
5097
5453
|
# @return [Float]
|
5098
5454
|
#
|
5099
5455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PlayerLatency AWS API Documentation
|
@@ -5107,10 +5463,10 @@ module Aws::GameLift
|
|
5107
5463
|
|
5108
5464
|
# Queue setting that determines the highest latency allowed for
|
5109
5465
|
# individual players when placing a game session. When a latency policy
|
5110
|
-
# is in force, a game session cannot be placed
|
5111
|
-
#
|
5112
|
-
#
|
5113
|
-
#
|
5466
|
+
# is in force, a game session cannot be placed with any fleet in a
|
5467
|
+
# Region where a player reports latency higher than the cap. Latency
|
5468
|
+
# policies are only enforced when the placement request contains player
|
5469
|
+
# latency information.
|
5114
5470
|
#
|
5115
5471
|
# * CreateGameSessionQueue
|
5116
5472
|
#
|
@@ -5175,24 +5531,33 @@ module Aws::GameLift
|
|
5175
5531
|
# * StopGameSessionPlacement
|
5176
5532
|
#
|
5177
5533
|
# @!attribute [rw] player_session_id
|
5178
|
-
#
|
5534
|
+
# A unique identifier for a player session.
|
5179
5535
|
# @return [String]
|
5180
5536
|
#
|
5181
5537
|
# @!attribute [rw] player_id
|
5182
|
-
#
|
5538
|
+
# A unique identifier for a player that is associated with this player
|
5183
5539
|
# session.
|
5184
5540
|
# @return [String]
|
5185
5541
|
#
|
5186
5542
|
# @!attribute [rw] game_session_id
|
5187
|
-
#
|
5543
|
+
# A unique identifier for the game session that the player session is
|
5188
5544
|
# connected to.
|
5189
5545
|
# @return [String]
|
5190
5546
|
#
|
5191
5547
|
# @!attribute [rw] fleet_id
|
5192
|
-
#
|
5548
|
+
# A unique identifier for a fleet that the player's game session is
|
5193
5549
|
# running on.
|
5194
5550
|
# @return [String]
|
5195
5551
|
#
|
5552
|
+
# @!attribute [rw] fleet_arn
|
5553
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
5554
|
+
# fleet that the player's game session is running on.
|
5555
|
+
#
|
5556
|
+
#
|
5557
|
+
#
|
5558
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5559
|
+
# @return [String]
|
5560
|
+
#
|
5196
5561
|
# @!attribute [rw] creation_time
|
5197
5562
|
# Time stamp indicating when this data object was created. Format is a
|
5198
5563
|
# number expressed in Unix time as milliseconds (for example
|
@@ -5225,11 +5590,28 @@ module Aws::GameLift
|
|
5225
5590
|
# @return [String]
|
5226
5591
|
#
|
5227
5592
|
# @!attribute [rw] ip_address
|
5228
|
-
# IP address of the
|
5229
|
-
#
|
5593
|
+
# IP address of the instance that is running the game session. When
|
5594
|
+
# connecting to a Amazon GameLift game server, a client needs to
|
5595
|
+
# reference an IP address (or DNS name) and port number.
|
5230
5596
|
# @return [String]
|
5231
5597
|
#
|
5232
5598
|
# @!attribute [rw] dns_name
|
5599
|
+
# DNS identifier assigned to the instance that is running the game
|
5600
|
+
# session. Values have the following format:
|
5601
|
+
#
|
5602
|
+
# * TLS-enabled fleets: `<unique identifier>.<region
|
5603
|
+
# identifier>.amazongamelift.com`.
|
5604
|
+
#
|
5605
|
+
# * Non-TLS-enabled fleets: `ec2-<unique
|
5606
|
+
# identifier>.compute.amazonaws.com`. (See [Amazon EC2 Instance IP
|
5607
|
+
# Addressing][1].)
|
5608
|
+
#
|
5609
|
+
# When connecting to a game session that is running on a TLS-enabled
|
5610
|
+
# fleet, you must use the DNS name, not the IP address.
|
5611
|
+
#
|
5612
|
+
#
|
5613
|
+
#
|
5614
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses
|
5233
5615
|
# @return [String]
|
5234
5616
|
#
|
5235
5617
|
# @!attribute [rw] port
|
@@ -5250,6 +5632,7 @@ module Aws::GameLift
|
|
5250
5632
|
:player_id,
|
5251
5633
|
:game_session_id,
|
5252
5634
|
:fleet_id,
|
5635
|
+
:fleet_arn,
|
5253
5636
|
:creation_time,
|
5254
5637
|
:termination_time,
|
5255
5638
|
:status,
|
@@ -5281,14 +5664,15 @@ module Aws::GameLift
|
|
5281
5664
|
# }
|
5282
5665
|
#
|
5283
5666
|
# @!attribute [rw] name
|
5284
|
-
#
|
5667
|
+
# A descriptive label that is associated with a scaling policy. Policy
|
5285
5668
|
# names do not need to be unique. A fleet can have only one scaling
|
5286
5669
|
# policy with the same name.
|
5287
5670
|
# @return [String]
|
5288
5671
|
#
|
5289
5672
|
# @!attribute [rw] fleet_id
|
5290
|
-
#
|
5291
|
-
# cannot be in any of the
|
5673
|
+
# A unique identifier for a fleet to apply this policy to. You can use
|
5674
|
+
# either the fleet ID or ARN value. The fleet cannot be in any of the
|
5675
|
+
# following statuses: ERROR or DELETING.
|
5292
5676
|
# @return [String]
|
5293
5677
|
#
|
5294
5678
|
# @!attribute [rw] scaling_adjustment
|
@@ -5296,7 +5680,7 @@ module Aws::GameLift
|
|
5296
5680
|
# @return [Integer]
|
5297
5681
|
#
|
5298
5682
|
# @!attribute [rw] scaling_adjustment_type
|
5299
|
-
#
|
5683
|
+
# The type of adjustment to make to a fleet's instance count (see
|
5300
5684
|
# FleetCapacity):
|
5301
5685
|
#
|
5302
5686
|
# * **ChangeInCapacity** -- add (or subtract) the scaling adjustment
|
@@ -5375,8 +5759,8 @@ module Aws::GameLift
|
|
5375
5759
|
# @return [String]
|
5376
5760
|
#
|
5377
5761
|
# @!attribute [rw] policy_type
|
5378
|
-
#
|
5379
|
-
# parameter *MetricName* to 'PercentAvailableGameSessions' and
|
5762
|
+
# The type of scaling policy to create. For a target-based policy, set
|
5763
|
+
# the parameter *MetricName* to 'PercentAvailableGameSessions' and
|
5380
5764
|
# specify a *TargetConfiguration*. For a rule-based policy set the
|
5381
5765
|
# following parameters: *MetricName*, *ComparisonOperator*,
|
5382
5766
|
# *Threshold*, *EvaluationPeriods*, *ScalingAdjustmentType*, and
|
@@ -5384,7 +5768,7 @@ module Aws::GameLift
|
|
5384
5768
|
# @return [String]
|
5385
5769
|
#
|
5386
5770
|
# @!attribute [rw] target_configuration
|
5387
|
-
#
|
5771
|
+
# The settings for a target-based scaling policy.
|
5388
5772
|
# @return [Types::TargetConfiguration]
|
5389
5773
|
#
|
5390
5774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PutScalingPolicyInput AWS API Documentation
|
@@ -5406,7 +5790,7 @@ module Aws::GameLift
|
|
5406
5790
|
# Represents the returned data in response to a request action.
|
5407
5791
|
#
|
5408
5792
|
# @!attribute [rw] name
|
5409
|
-
#
|
5793
|
+
# A descriptive label that is associated with a scaling policy. Policy
|
5410
5794
|
# names do not need to be unique.
|
5411
5795
|
# @return [String]
|
5412
5796
|
#
|
@@ -5427,7 +5811,8 @@ module Aws::GameLift
|
|
5427
5811
|
# }
|
5428
5812
|
#
|
5429
5813
|
# @!attribute [rw] build_id
|
5430
|
-
#
|
5814
|
+
# A unique identifier for a build to get credentials for. You can use
|
5815
|
+
# either the build ID or ARN value.
|
5431
5816
|
# @return [String]
|
5432
5817
|
#
|
5433
5818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RequestUploadCredentialsInput AWS API Documentation
|
@@ -5468,7 +5853,8 @@ module Aws::GameLift
|
|
5468
5853
|
# }
|
5469
5854
|
#
|
5470
5855
|
# @!attribute [rw] alias_id
|
5471
|
-
#
|
5856
|
+
# The unique identifier of the alias that you want to retrieve a fleet
|
5857
|
+
# ID for. You can use either the alias ID or ARN value.
|
5472
5858
|
# @return [String]
|
5473
5859
|
#
|
5474
5860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResolveAliasInput AWS API Documentation
|
@@ -5481,28 +5867,39 @@ module Aws::GameLift
|
|
5481
5867
|
# Represents the returned data in response to a request action.
|
5482
5868
|
#
|
5483
5869
|
# @!attribute [rw] fleet_id
|
5484
|
-
#
|
5870
|
+
# The fleet identifier that the alias is pointing to.
|
5871
|
+
# @return [String]
|
5872
|
+
#
|
5873
|
+
# @!attribute [rw] fleet_arn
|
5874
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
5875
|
+
# fleet resource that this alias points to.
|
5876
|
+
#
|
5877
|
+
#
|
5878
|
+
#
|
5879
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5485
5880
|
# @return [String]
|
5486
5881
|
#
|
5487
5882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResolveAliasOutput AWS API Documentation
|
5488
5883
|
#
|
5489
5884
|
class ResolveAliasOutput < Struct.new(
|
5490
|
-
:fleet_id
|
5885
|
+
:fleet_id,
|
5886
|
+
:fleet_arn)
|
5491
5887
|
include Aws::Structure
|
5492
5888
|
end
|
5493
5889
|
|
5494
|
-
#
|
5495
|
-
# the same fleet. This optional policy gives game owners control over
|
5890
|
+
# A policy that limits the number of game sessions a player can create
|
5891
|
+
# on the same fleet. This optional policy gives game owners control over
|
5496
5892
|
# how players can consume available game server resources. A resource
|
5497
5893
|
# creation policy makes the following statement: "An individual player
|
5498
5894
|
# can create a maximum number of new game sessions within a specified
|
5499
5895
|
# time period".
|
5500
5896
|
#
|
5501
5897
|
# The policy is evaluated when a player tries to create a new game
|
5502
|
-
# session. For example
|
5503
|
-
# period of 60 minutes
|
5504
|
-
# Amazon GameLift checks that the player (identified by
|
5505
|
-
# created fewer than 10 game sessions in the past 60
|
5898
|
+
# session. For example: Assume you have a policy of 10 new game sessions
|
5899
|
+
# and a time period of 60 minutes. On receiving a `CreateGameSession`
|
5900
|
+
# request, Amazon GameLift checks that the player (identified by
|
5901
|
+
# `CreatorId`) has created fewer than 10 game sessions in the past 60
|
5902
|
+
# minutes.
|
5506
5903
|
#
|
5507
5904
|
# @note When making an API call, you may pass ResourceCreationLimitPolicy
|
5508
5905
|
# data as a hash:
|
@@ -5513,12 +5910,12 @@ module Aws::GameLift
|
|
5513
5910
|
# }
|
5514
5911
|
#
|
5515
5912
|
# @!attribute [rw] new_game_sessions_per_creator
|
5516
|
-
#
|
5517
|
-
# the policy period.
|
5913
|
+
# The maximum number of game sessions that an individual can create
|
5914
|
+
# during the policy period.
|
5518
5915
|
# @return [Integer]
|
5519
5916
|
#
|
5520
5917
|
# @!attribute [rw] policy_period_in_minutes
|
5521
|
-
#
|
5918
|
+
# The time span used in evaluating the resource creation limit policy.
|
5522
5919
|
# @return [Integer]
|
5523
5920
|
#
|
5524
5921
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResourceCreationLimitPolicy AWS API Documentation
|
@@ -5529,7 +5926,7 @@ module Aws::GameLift
|
|
5529
5926
|
include Aws::Structure
|
5530
5927
|
end
|
5531
5928
|
|
5532
|
-
#
|
5929
|
+
# The routing configuration for a fleet alias.
|
5533
5930
|
#
|
5534
5931
|
# * CreateAlias
|
5535
5932
|
#
|
@@ -5553,25 +5950,26 @@ module Aws::GameLift
|
|
5553
5950
|
# }
|
5554
5951
|
#
|
5555
5952
|
# @!attribute [rw] type
|
5556
|
-
#
|
5953
|
+
# The type of routing strategy for the alias.
|
5557
5954
|
#
|
5558
5955
|
# Possible routing types include the following:
|
5559
5956
|
#
|
5560
|
-
# * **SIMPLE**
|
5957
|
+
# * **SIMPLE** - The alias resolves to one specific fleet. Use this
|
5561
5958
|
# type when routing to active fleets.
|
5562
5959
|
#
|
5563
|
-
# * **TERMINAL**
|
5960
|
+
# * **TERMINAL** - The alias does not resolve to a fleet but instead
|
5564
5961
|
# can be used to display a message to the user. A terminal alias
|
5565
5962
|
# throws a TerminalRoutingStrategyException with the RoutingStrategy
|
5566
5963
|
# message embedded.
|
5567
5964
|
# @return [String]
|
5568
5965
|
#
|
5569
5966
|
# @!attribute [rw] fleet_id
|
5570
|
-
#
|
5967
|
+
# The unique identifier for a fleet that the alias points to. This
|
5968
|
+
# value is the fleet ID, not the fleet ARN.
|
5571
5969
|
# @return [String]
|
5572
5970
|
#
|
5573
5971
|
# @!attribute [rw] message
|
5574
|
-
#
|
5972
|
+
# The message text to be used with a terminal routing strategy.
|
5575
5973
|
# @return [String]
|
5576
5974
|
#
|
5577
5975
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RoutingStrategy AWS API Documentation
|
@@ -5587,16 +5985,16 @@ module Aws::GameLift
|
|
5587
5985
|
# processes to run on each instance in a fleet. Server processes run
|
5588
5986
|
# either a custom game build executable or a Realtime Servers script.
|
5589
5987
|
# Each instance in the fleet starts the specified server processes and
|
5590
|
-
# continues to start new processes as existing processes end.
|
5591
|
-
# instance regularly checks for an updated
|
5988
|
+
# continues to start new processes as existing processes end. Each
|
5989
|
+
# instance regularly checks for an updated runtime configuration.
|
5592
5990
|
#
|
5593
|
-
# The
|
5991
|
+
# The runtime configuration enables the instances in a fleet to run
|
5594
5992
|
# multiple processes simultaneously. Learn more about [ Running Multiple
|
5595
5993
|
# Processes on a Fleet ][1].
|
5596
5994
|
#
|
5597
5995
|
# A Amazon GameLift instance is limited to 50 processes running
|
5598
5996
|
# simultaneously. To calculate the total number of processes in a
|
5599
|
-
#
|
5997
|
+
# runtime configuration, add the values of the `ConcurrentExecutions`
|
5600
5998
|
# parameter for each ServerProcess object.
|
5601
5999
|
#
|
5602
6000
|
# * CreateFleet
|
@@ -5605,31 +6003,9 @@ module Aws::GameLift
|
|
5605
6003
|
#
|
5606
6004
|
# * DeleteFleet
|
5607
6005
|
#
|
5608
|
-
# *
|
5609
|
-
#
|
5610
|
-
# * DescribeFleetAttributes
|
5611
|
-
#
|
5612
|
-
# * DescribeFleetCapacity
|
5613
|
-
#
|
5614
|
-
# * DescribeFleetPortSettings
|
5615
|
-
#
|
5616
|
-
# * DescribeFleetUtilization
|
5617
|
-
#
|
5618
|
-
# * DescribeRuntimeConfiguration
|
5619
|
-
#
|
5620
|
-
# * DescribeEC2InstanceLimits
|
5621
|
-
#
|
5622
|
-
# * DescribeFleetEvents
|
6006
|
+
# * DescribeFleetAttributes
|
5623
6007
|
#
|
5624
|
-
# *
|
5625
|
-
#
|
5626
|
-
# * UpdateFleetAttributes
|
5627
|
-
#
|
5628
|
-
# * UpdateFleetCapacity
|
5629
|
-
#
|
5630
|
-
# * UpdateFleetPortSettings
|
5631
|
-
#
|
5632
|
-
# * UpdateRuntimeConfiguration
|
6008
|
+
# * UpdateFleetAttributes
|
5633
6009
|
#
|
5634
6010
|
# * Manage fleet actions:
|
5635
6011
|
#
|
@@ -5657,22 +6033,22 @@ module Aws::GameLift
|
|
5657
6033
|
# }
|
5658
6034
|
#
|
5659
6035
|
# @!attribute [rw] server_processes
|
5660
|
-
#
|
6036
|
+
# A collection of server process configurations that describe which
|
5661
6037
|
# server processes to run on each instance in a fleet.
|
5662
6038
|
# @return [Array<Types::ServerProcess>]
|
5663
6039
|
#
|
5664
6040
|
# @!attribute [rw] max_concurrent_game_session_activations
|
5665
|
-
#
|
5666
|
-
# an instance simultaneously. This setting limits the amount
|
5667
|
-
# instance resources that can be used for new game activations at
|
5668
|
-
# one time.
|
6041
|
+
# The maximum number of game sessions with status `ACTIVATING` to
|
6042
|
+
# allow on an instance simultaneously. This setting limits the amount
|
6043
|
+
# of instance resources that can be used for new game activations at
|
6044
|
+
# any one time.
|
5669
6045
|
# @return [Integer]
|
5670
6046
|
#
|
5671
6047
|
# @!attribute [rw] game_session_activation_timeout_seconds
|
5672
|
-
#
|
5673
|
-
# in status `ACTIVATING`. If the game session is not active
|
5674
|
-
# timeout, activation is terminated and the game session
|
5675
|
-
# changed to `TERMINATED`.
|
6048
|
+
# The maximum amount of time (in seconds) that a game session can
|
6049
|
+
# remain in status `ACTIVATING`. If the game session is not active
|
6050
|
+
# before the timeout, activation is terminated and the game session
|
6051
|
+
# status is changed to `TERMINATED`.
|
5676
6052
|
# @return [Integer]
|
5677
6053
|
#
|
5678
6054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RuntimeConfiguration AWS API Documentation
|
@@ -5684,9 +6060,9 @@ module Aws::GameLift
|
|
5684
6060
|
include Aws::Structure
|
5685
6061
|
end
|
5686
6062
|
|
5687
|
-
#
|
5688
|
-
#
|
5689
|
-
#
|
6063
|
+
# The location in Amazon S3 where build or script files are stored for
|
6064
|
+
# access by Amazon GameLift. This location is specified in CreateBuild,
|
6065
|
+
# CreateScript, and UpdateScript requests.
|
5690
6066
|
#
|
5691
6067
|
# @note When making an API call, you may pass S3Location
|
5692
6068
|
# data as a hash:
|
@@ -5699,16 +6075,17 @@ module Aws::GameLift
|
|
5699
6075
|
# }
|
5700
6076
|
#
|
5701
6077
|
# @!attribute [rw] bucket
|
5702
|
-
# Amazon S3 bucket identifier. This is the name of the S3 bucket.
|
6078
|
+
# An Amazon S3 bucket identifier. This is the name of the S3 bucket.
|
5703
6079
|
# @return [String]
|
5704
6080
|
#
|
5705
6081
|
# @!attribute [rw] key
|
5706
|
-
#
|
6082
|
+
# The name of the zip file that contains the build files or script
|
6083
|
+
# files.
|
5707
6084
|
# @return [String]
|
5708
6085
|
#
|
5709
6086
|
# @!attribute [rw] role_arn
|
5710
|
-
# Amazon Resource Name ([ARN][1]) for an IAM role that allows
|
5711
|
-
# GameLift to access the S3 bucket.
|
6087
|
+
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows
|
6088
|
+
# Amazon GameLift to access the S3 bucket.
|
5712
6089
|
#
|
5713
6090
|
#
|
5714
6091
|
#
|
@@ -5716,10 +6093,10 @@ module Aws::GameLift
|
|
5716
6093
|
# @return [String]
|
5717
6094
|
#
|
5718
6095
|
# @!attribute [rw] object_version
|
5719
|
-
#
|
6096
|
+
# The version of the file, if object versioning is turned on for the
|
5720
6097
|
# bucket. Amazon GameLift uses this information when retrieving files
|
5721
6098
|
# from an S3 bucket that you own. Use this parameter to specify a
|
5722
|
-
# specific version of the file
|
6099
|
+
# specific version of the file. If not set, the latest version of the
|
5723
6100
|
# file is retrieved.
|
5724
6101
|
# @return [String]
|
5725
6102
|
#
|
@@ -5757,12 +6134,12 @@ module Aws::GameLift
|
|
5757
6134
|
# * StopFleetActions
|
5758
6135
|
#
|
5759
6136
|
# @!attribute [rw] fleet_id
|
5760
|
-
#
|
6137
|
+
# A unique identifier for a fleet that is associated with this scaling
|
5761
6138
|
# policy.
|
5762
6139
|
# @return [String]
|
5763
6140
|
#
|
5764
6141
|
# @!attribute [rw] name
|
5765
|
-
#
|
6142
|
+
# A descriptive label that is associated with a scaling policy. Policy
|
5766
6143
|
# names do not need to be unique.
|
5767
6144
|
# @return [String]
|
5768
6145
|
#
|
@@ -5797,7 +6174,7 @@ module Aws::GameLift
|
|
5797
6174
|
# @return [Integer]
|
5798
6175
|
#
|
5799
6176
|
# @!attribute [rw] scaling_adjustment_type
|
5800
|
-
#
|
6177
|
+
# The type of adjustment to make to a fleet's instance count (see
|
5801
6178
|
# FleetCapacity):
|
5802
6179
|
#
|
5803
6180
|
# * **ChangeInCapacity** -- add (or subtract) the scaling adjustment
|
@@ -5875,8 +6252,8 @@ module Aws::GameLift
|
|
5875
6252
|
# @return [String]
|
5876
6253
|
#
|
5877
6254
|
# @!attribute [rw] policy_type
|
5878
|
-
#
|
5879
|
-
# parameter *MetricName* to 'PercentAvailableGameSessions' and
|
6255
|
+
# The type of scaling policy to create. For a target-based policy, set
|
6256
|
+
# the parameter *MetricName* to 'PercentAvailableGameSessions' and
|
5880
6257
|
# specify a *TargetConfiguration*. For a rule-based policy set the
|
5881
6258
|
# following parameters: *MetricName*, *ComparisonOperator*,
|
5882
6259
|
# *Threshold*, *EvaluationPeriods*, *ScalingAdjustmentType*, and
|
@@ -5884,7 +6261,7 @@ module Aws::GameLift
|
|
5884
6261
|
# @return [String]
|
5885
6262
|
#
|
5886
6263
|
# @!attribute [rw] target_configuration
|
5887
|
-
#
|
6264
|
+
# The settings for a target-based scaling policy.
|
5888
6265
|
# @return [Types::TargetConfiguration]
|
5889
6266
|
#
|
5890
6267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ScalingPolicy AWS API Documentation
|
@@ -5919,41 +6296,53 @@ module Aws::GameLift
|
|
5919
6296
|
# * DeleteScript
|
5920
6297
|
#
|
5921
6298
|
# @!attribute [rw] script_id
|
5922
|
-
#
|
6299
|
+
# A unique identifier for a Realtime script
|
6300
|
+
# @return [String]
|
6301
|
+
#
|
6302
|
+
# @!attribute [rw] script_arn
|
6303
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift
|
6304
|
+
# script resource and uniquely identifies it. ARNs are unique across
|
6305
|
+
# all Regions. In a GameLift script ARN, the resource ID matches the
|
6306
|
+
# *ScriptId* value.
|
6307
|
+
#
|
6308
|
+
#
|
6309
|
+
#
|
6310
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5923
6311
|
# @return [String]
|
5924
6312
|
#
|
5925
6313
|
# @!attribute [rw] name
|
5926
|
-
#
|
5927
|
-
# not need to be unique.
|
6314
|
+
# A descriptive label that is associated with a script. Script names
|
6315
|
+
# do not need to be unique.
|
5928
6316
|
# @return [String]
|
5929
6317
|
#
|
5930
6318
|
# @!attribute [rw] version
|
5931
|
-
#
|
5932
|
-
# do not need to be unique.
|
6319
|
+
# The version that is associated with a build or script. Version
|
6320
|
+
# strings do not need to be unique.
|
5933
6321
|
# @return [String]
|
5934
6322
|
#
|
5935
6323
|
# @!attribute [rw] size_on_disk
|
5936
|
-
#
|
5937
|
-
# files are uploaded from an S3 location, this value remains at
|
6324
|
+
# The file size of the uploaded Realtime script, expressed in bytes.
|
6325
|
+
# When files are uploaded from an S3 location, this value remains at
|
6326
|
+
# "0".
|
5938
6327
|
# @return [Integer]
|
5939
6328
|
#
|
5940
6329
|
# @!attribute [rw] creation_time
|
5941
|
-
#
|
5942
|
-
# number expressed in Unix time as milliseconds (for
|
5943
|
-
# "1469498468.057").
|
6330
|
+
# A time stamp indicating when this data object was created. The
|
6331
|
+
# format is a number expressed in Unix time as milliseconds (for
|
6332
|
+
# example "1469498468.057").
|
5944
6333
|
# @return [Time]
|
5945
6334
|
#
|
5946
6335
|
# @!attribute [rw] storage_location
|
5947
|
-
#
|
5948
|
-
#
|
5949
|
-
#
|
5950
|
-
# requests.
|
6336
|
+
# The location in Amazon S3 where build or script files are stored for
|
6337
|
+
# access by Amazon GameLift. This location is specified in
|
6338
|
+
# CreateBuild, CreateScript, and UpdateScript requests.
|
5951
6339
|
# @return [Types::S3Location]
|
5952
6340
|
#
|
5953
6341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Script AWS API Documentation
|
5954
6342
|
#
|
5955
6343
|
class Script < Struct.new(
|
5956
6344
|
:script_id,
|
6345
|
+
:script_arn,
|
5957
6346
|
:name,
|
5958
6347
|
:version,
|
5959
6348
|
:size_on_disk,
|
@@ -5977,15 +6366,16 @@ module Aws::GameLift
|
|
5977
6366
|
# }
|
5978
6367
|
#
|
5979
6368
|
# @!attribute [rw] fleet_id
|
5980
|
-
#
|
5981
|
-
#
|
5982
|
-
# both.
|
6369
|
+
# A unique identifier for a fleet to search for active game sessions.
|
6370
|
+
# You can use either the fleet ID or ARN value. Each request must
|
6371
|
+
# reference either a fleet ID or alias ID, but not both.
|
5983
6372
|
# @return [String]
|
5984
6373
|
#
|
5985
6374
|
# @!attribute [rw] alias_id
|
5986
|
-
#
|
5987
|
-
# for active game sessions.
|
5988
|
-
# ID or alias ID,
|
6375
|
+
# A unique identifier for an alias associated with the fleet to search
|
6376
|
+
# for active game sessions. You can use either the alias ID or ARN
|
6377
|
+
# value. Each request must reference either a fleet ID or alias ID,
|
6378
|
+
# but not both.
|
5989
6379
|
# @return [String]
|
5990
6380
|
#
|
5991
6381
|
# @!attribute [rw] filter_expression
|
@@ -6054,7 +6444,7 @@ module Aws::GameLift
|
|
6054
6444
|
# @return [String]
|
6055
6445
|
#
|
6056
6446
|
# @!attribute [rw] limit
|
6057
|
-
#
|
6447
|
+
# The maximum number of results to return. Use this parameter with
|
6058
6448
|
# `NextToken` to get results as a set of sequential pages. The maximum
|
6059
6449
|
# number of results returned is 20, even if this value is not set or
|
6060
6450
|
# is set higher than 20.
|
@@ -6082,7 +6472,7 @@ module Aws::GameLift
|
|
6082
6472
|
# Represents the returned data in response to a request action.
|
6083
6473
|
#
|
6084
6474
|
# @!attribute [rw] game_sessions
|
6085
|
-
#
|
6475
|
+
# A collection of objects containing game session properties for each
|
6086
6476
|
# session matching the request.
|
6087
6477
|
# @return [Array<Types::GameSession>]
|
6088
6478
|
#
|
@@ -6119,10 +6509,10 @@ module Aws::GameLift
|
|
6119
6509
|
# }
|
6120
6510
|
#
|
6121
6511
|
# @!attribute [rw] launch_path
|
6122
|
-
#
|
6123
|
-
# of the Realtime script file that contains the `Init()`
|
6124
|
-
# Game builds and Realtime scripts are installed on
|
6125
|
-
# root:
|
6512
|
+
# The location of the server executable in a custom game build or the
|
6513
|
+
# name of the Realtime script file that contains the `Init()`
|
6514
|
+
# function. Game builds and Realtime scripts are installed on
|
6515
|
+
# instances at the root:
|
6126
6516
|
#
|
6127
6517
|
# * Windows (for custom game builds only): `C:\game`. Example:
|
6128
6518
|
# "`C:\game\MyGame\server.exe`"
|
@@ -6133,12 +6523,12 @@ module Aws::GameLift
|
|
6133
6523
|
# @return [String]
|
6134
6524
|
#
|
6135
6525
|
# @!attribute [rw] parameters
|
6136
|
-
#
|
6526
|
+
# An optional list of parameters to pass to the server executable or
|
6137
6527
|
# Realtime script on launch.
|
6138
6528
|
# @return [String]
|
6139
6529
|
#
|
6140
6530
|
# @!attribute [rw] concurrent_executions
|
6141
|
-
#
|
6531
|
+
# The number of server processes that use this configuration to run
|
6142
6532
|
# concurrently on an instance.
|
6143
6533
|
# @return [Integer]
|
6144
6534
|
#
|
@@ -6160,7 +6550,8 @@ module Aws::GameLift
|
|
6160
6550
|
# }
|
6161
6551
|
#
|
6162
6552
|
# @!attribute [rw] fleet_id
|
6163
|
-
#
|
6553
|
+
# A unique identifier for a fleet to start actions on. You can use
|
6554
|
+
# either the fleet ID or ARN value.
|
6164
6555
|
# @return [String]
|
6165
6556
|
#
|
6166
6557
|
# @!attribute [rw] actions
|
@@ -6212,14 +6603,15 @@ module Aws::GameLift
|
|
6212
6603
|
# }
|
6213
6604
|
#
|
6214
6605
|
# @!attribute [rw] placement_id
|
6215
|
-
#
|
6216
|
-
# value is developer-defined. The value must be unique across all
|
6217
|
-
#
|
6606
|
+
# A unique identifier to assign to the new game session placement.
|
6607
|
+
# This value is developer-defined. The value must be unique across all
|
6608
|
+
# Regions and cannot be reused unless you are resubmitting a canceled
|
6218
6609
|
# or timed-out placement request.
|
6219
6610
|
# @return [String]
|
6220
6611
|
#
|
6221
6612
|
# @!attribute [rw] game_session_queue_name
|
6222
|
-
# Name of the queue to use to place the new game session.
|
6613
|
+
# Name of the queue to use to place the new game session. You can use
|
6614
|
+
# either the qieue name or ARN value.
|
6223
6615
|
# @return [String]
|
6224
6616
|
#
|
6225
6617
|
# @!attribute [rw] game_properties
|
@@ -6234,18 +6626,18 @@ module Aws::GameLift
|
|
6234
6626
|
# @return [Array<Types::GameProperty>]
|
6235
6627
|
#
|
6236
6628
|
# @!attribute [rw] maximum_player_session_count
|
6237
|
-
#
|
6238
|
-
# the game session.
|
6629
|
+
# The maximum number of players that can be connected simultaneously
|
6630
|
+
# to the game session.
|
6239
6631
|
# @return [Integer]
|
6240
6632
|
#
|
6241
6633
|
# @!attribute [rw] game_session_name
|
6242
|
-
#
|
6634
|
+
# A descriptive label that is associated with a game session. Session
|
6243
6635
|
# names do not need to be unique.
|
6244
6636
|
# @return [String]
|
6245
6637
|
#
|
6246
6638
|
# @!attribute [rw] player_latencies
|
6247
6639
|
# Set of values, expressed in milliseconds, indicating the amount of
|
6248
|
-
# latency that a player experiences when connected to AWS
|
6640
|
+
# latency that a player experiences when connected to AWS Regions.
|
6249
6641
|
# This information is used to try to place the new game session where
|
6250
6642
|
# it can offer the best possible gameplay experience for the players.
|
6251
6643
|
# @return [Array<Types::PlayerLatency>]
|
@@ -6301,7 +6693,7 @@ module Aws::GameLift
|
|
6301
6693
|
#
|
6302
6694
|
# {
|
6303
6695
|
# ticket_id: "MatchmakingIdStringModel",
|
6304
|
-
# configuration_name: "
|
6696
|
+
# configuration_name: "MatchmakingConfigurationName", # required
|
6305
6697
|
# game_session_arn: "ArnStringModel", # required
|
6306
6698
|
# players: [ # required
|
6307
6699
|
# {
|
@@ -6318,30 +6710,26 @@ module Aws::GameLift
|
|
6318
6710
|
# }
|
6319
6711
|
#
|
6320
6712
|
# @!attribute [rw] ticket_id
|
6321
|
-
#
|
6713
|
+
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
6322
6714
|
# specified here, Amazon GameLift will generate one in the form of a
|
6323
6715
|
# UUID. Use this identifier to track the match backfill ticket status
|
6324
6716
|
# and retrieve match results.
|
6325
6717
|
# @return [String]
|
6326
6718
|
#
|
6327
6719
|
# @!attribute [rw] configuration_name
|
6328
|
-
# Name of the matchmaker to use for this request.
|
6329
|
-
#
|
6330
|
-
# the
|
6331
|
-
#
|
6332
|
-
# matchmaker name. (In the ARN value
|
6333
|
-
# "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4",
|
6334
|
-
# the matchmaking configuration name is "MM-4v4".) Use only the name
|
6335
|
-
# for this parameter.
|
6720
|
+
# Name of the matchmaker to use for this request. You can use either
|
6721
|
+
# the configuration name or ARN value. The ARN of the matchmaker that
|
6722
|
+
# was used with the original game session is listed in the GameSession
|
6723
|
+
# object, `MatchmakerData` property.
|
6336
6724
|
# @return [String]
|
6337
6725
|
#
|
6338
6726
|
# @!attribute [rw] game_session_arn
|
6339
6727
|
# Amazon Resource Name ([ARN][1]) that is assigned to a game session
|
6340
|
-
# and uniquely identifies it.
|
6728
|
+
# and uniquely identifies it. This is the same as the game session ID.
|
6341
6729
|
#
|
6342
6730
|
#
|
6343
6731
|
#
|
6344
|
-
# [1]: https://docs.aws.amazon.com/
|
6732
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
6345
6733
|
# @return [String]
|
6346
6734
|
#
|
6347
6735
|
# @!attribute [rw] players
|
@@ -6356,9 +6744,9 @@ module Aws::GameLift
|
|
6356
6744
|
# more details, see [ Match Data][1].
|
6357
6745
|
#
|
6358
6746
|
# * LatencyInMs -\\\\- If the matchmaker uses player latency, include
|
6359
|
-
# a latency value, in milliseconds, for the
|
6747
|
+
# a latency value, in milliseconds, for the Region that the game
|
6360
6748
|
# session is currently in. Do not include latency values for any
|
6361
|
-
# other
|
6749
|
+
# other Region.
|
6362
6750
|
#
|
6363
6751
|
#
|
6364
6752
|
#
|
@@ -6397,7 +6785,7 @@ module Aws::GameLift
|
|
6397
6785
|
#
|
6398
6786
|
# {
|
6399
6787
|
# ticket_id: "MatchmakingIdStringModel",
|
6400
|
-
# configuration_name: "
|
6788
|
+
# configuration_name: "MatchmakingConfigurationName", # required
|
6401
6789
|
# players: [ # required
|
6402
6790
|
# {
|
6403
6791
|
# player_id: "NonZeroAndMaxString",
|
@@ -6413,7 +6801,7 @@ module Aws::GameLift
|
|
6413
6801
|
# }
|
6414
6802
|
#
|
6415
6803
|
# @!attribute [rw] ticket_id
|
6416
|
-
#
|
6804
|
+
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
6417
6805
|
# specified here, Amazon GameLift will generate one in the form of a
|
6418
6806
|
# UUID. Use this identifier to track the matchmaking ticket status and
|
6419
6807
|
# retrieve match results.
|
@@ -6421,8 +6809,8 @@ module Aws::GameLift
|
|
6421
6809
|
#
|
6422
6810
|
# @!attribute [rw] configuration_name
|
6423
6811
|
# Name of the matchmaking configuration to use for this request.
|
6424
|
-
# Matchmaking configurations must exist in the same
|
6425
|
-
# request.
|
6812
|
+
# Matchmaking configurations must exist in the same Region as this
|
6813
|
+
# request. You can use either the configuration name or ARN value.
|
6426
6814
|
# @return [String]
|
6427
6815
|
#
|
6428
6816
|
# @!attribute [rw] players
|
@@ -6466,7 +6854,8 @@ module Aws::GameLift
|
|
6466
6854
|
# }
|
6467
6855
|
#
|
6468
6856
|
# @!attribute [rw] fleet_id
|
6469
|
-
#
|
6857
|
+
# A unique identifier for a fleet to stop actions on. You can use
|
6858
|
+
# either the fleet ID or ARN value.
|
6470
6859
|
# @return [String]
|
6471
6860
|
#
|
6472
6861
|
# @!attribute [rw] actions
|
@@ -6495,7 +6884,7 @@ module Aws::GameLift
|
|
6495
6884
|
# }
|
6496
6885
|
#
|
6497
6886
|
# @!attribute [rw] placement_id
|
6498
|
-
#
|
6887
|
+
# A unique identifier for a game session placement to cancel.
|
6499
6888
|
# @return [String]
|
6500
6889
|
#
|
6501
6890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopGameSessionPlacementInput AWS API Documentation
|
@@ -6529,7 +6918,7 @@ module Aws::GameLift
|
|
6529
6918
|
# }
|
6530
6919
|
#
|
6531
6920
|
# @!attribute [rw] ticket_id
|
6532
|
-
#
|
6921
|
+
# A unique identifier for a matchmaking ticket.
|
6533
6922
|
# @return [String]
|
6534
6923
|
#
|
6535
6924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopMatchmakingInput AWS API Documentation
|
@@ -6543,6 +6932,115 @@ module Aws::GameLift
|
|
6543
6932
|
#
|
6544
6933
|
class StopMatchmakingOutput < Aws::EmptyStructure; end
|
6545
6934
|
|
6935
|
+
# A label that can be assigned to a GameLift resource.
|
6936
|
+
#
|
6937
|
+
# **Learn more**
|
6938
|
+
#
|
6939
|
+
# [Tagging AWS Resources][1] in the *AWS General Reference*
|
6940
|
+
#
|
6941
|
+
# [ AWS Tagging Strategies][2]
|
6942
|
+
#
|
6943
|
+
# **Related operations**
|
6944
|
+
#
|
6945
|
+
# * TagResource
|
6946
|
+
#
|
6947
|
+
# * UntagResource
|
6948
|
+
#
|
6949
|
+
# * ListTagsForResource
|
6950
|
+
#
|
6951
|
+
#
|
6952
|
+
#
|
6953
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6954
|
+
# [2]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/
|
6955
|
+
#
|
6956
|
+
# @note When making an API call, you may pass Tag
|
6957
|
+
# data as a hash:
|
6958
|
+
#
|
6959
|
+
# {
|
6960
|
+
# key: "TagKey", # required
|
6961
|
+
# value: "TagValue", # required
|
6962
|
+
# }
|
6963
|
+
#
|
6964
|
+
# @!attribute [rw] key
|
6965
|
+
# The key for a developer-defined key:value pair for tagging an AWS
|
6966
|
+
# resource.
|
6967
|
+
# @return [String]
|
6968
|
+
#
|
6969
|
+
# @!attribute [rw] value
|
6970
|
+
# The value for a developer-defined key:value pair for tagging an AWS
|
6971
|
+
# resource.
|
6972
|
+
# @return [String]
|
6973
|
+
#
|
6974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Tag AWS API Documentation
|
6975
|
+
#
|
6976
|
+
class Tag < Struct.new(
|
6977
|
+
:key,
|
6978
|
+
:value)
|
6979
|
+
include Aws::Structure
|
6980
|
+
end
|
6981
|
+
|
6982
|
+
# @note When making an API call, you may pass TagResourceRequest
|
6983
|
+
# data as a hash:
|
6984
|
+
#
|
6985
|
+
# {
|
6986
|
+
# resource_arn: "AmazonResourceName", # required
|
6987
|
+
# tags: [ # required
|
6988
|
+
# {
|
6989
|
+
# key: "TagKey", # required
|
6990
|
+
# value: "TagValue", # required
|
6991
|
+
# },
|
6992
|
+
# ],
|
6993
|
+
# }
|
6994
|
+
#
|
6995
|
+
# @!attribute [rw] resource_arn
|
6996
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
6997
|
+
# identifies the GameLift resource that you want to assign tags to.
|
6998
|
+
# GameLift resource ARNs are included in the data object for the
|
6999
|
+
# resource, which can be retrieved by calling a List or Describe
|
7000
|
+
# action for the resource type.
|
7001
|
+
#
|
7002
|
+
#
|
7003
|
+
#
|
7004
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
7005
|
+
# @return [String]
|
7006
|
+
#
|
7007
|
+
# @!attribute [rw] tags
|
7008
|
+
# A list of one or more tags to assign to the specified GameLift
|
7009
|
+
# resource. Tags are developer-defined and structured as key-value
|
7010
|
+
# pairs. The maximum tag limit may be lower than stated. See [ Tagging
|
7011
|
+
# AWS Resources][1] for actual tagging limits.
|
7012
|
+
#
|
7013
|
+
#
|
7014
|
+
#
|
7015
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
7016
|
+
# @return [Array<Types::Tag>]
|
7017
|
+
#
|
7018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TagResourceRequest AWS API Documentation
|
7019
|
+
#
|
7020
|
+
class TagResourceRequest < Struct.new(
|
7021
|
+
:resource_arn,
|
7022
|
+
:tags)
|
7023
|
+
include Aws::Structure
|
7024
|
+
end
|
7025
|
+
|
7026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TagResourceResponse AWS API Documentation
|
7027
|
+
#
|
7028
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
7029
|
+
|
7030
|
+
# The requested tagging operation did not succeed. This may be due to
|
7031
|
+
# invalid tag format or the maximum tag limit may have been exceeded.
|
7032
|
+
# Resolve the issue before retrying.
|
7033
|
+
#
|
7034
|
+
# @!attribute [rw] message
|
7035
|
+
# @return [String]
|
7036
|
+
#
|
7037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TaggingFailedException AWS API Documentation
|
7038
|
+
#
|
7039
|
+
class TaggingFailedException < Struct.new(
|
7040
|
+
:message)
|
7041
|
+
include Aws::Structure
|
7042
|
+
end
|
7043
|
+
|
6546
7044
|
# Settings for a target-based scaling policy (see ScalingPolicy. A
|
6547
7045
|
# target-based policy tracks a particular fleet metric specifies a
|
6548
7046
|
# target value for the metric. As player usage changes, the policy
|
@@ -6622,7 +7120,7 @@ module Aws::GameLift
|
|
6622
7120
|
include Aws::Structure
|
6623
7121
|
end
|
6624
7122
|
|
6625
|
-
# The requested operation is not supported in the
|
7123
|
+
# The requested operation is not supported in the Region specified.
|
6626
7124
|
#
|
6627
7125
|
# @!attribute [rw] message
|
6628
7126
|
# @return [String]
|
@@ -6634,6 +7132,44 @@ module Aws::GameLift
|
|
6634
7132
|
include Aws::Structure
|
6635
7133
|
end
|
6636
7134
|
|
7135
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
7136
|
+
# data as a hash:
|
7137
|
+
#
|
7138
|
+
# {
|
7139
|
+
# resource_arn: "AmazonResourceName", # required
|
7140
|
+
# tag_keys: ["TagKey"], # required
|
7141
|
+
# }
|
7142
|
+
#
|
7143
|
+
# @!attribute [rw] resource_arn
|
7144
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
7145
|
+
# identifies the GameLift resource that you want to remove tags from.
|
7146
|
+
# GameLift resource ARNs are included in the data object for the
|
7147
|
+
# resource, which can be retrieved by calling a List or Describe
|
7148
|
+
# action for the resource type.
|
7149
|
+
#
|
7150
|
+
#
|
7151
|
+
#
|
7152
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
7153
|
+
# @return [String]
|
7154
|
+
#
|
7155
|
+
# @!attribute [rw] tag_keys
|
7156
|
+
# A list of one or more tags to remove from the specified GameLift
|
7157
|
+
# resource. Tags are developer-defined and structured as key-value
|
7158
|
+
# pairs.
|
7159
|
+
# @return [Array<String>]
|
7160
|
+
#
|
7161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UntagResourceRequest AWS API Documentation
|
7162
|
+
#
|
7163
|
+
class UntagResourceRequest < Struct.new(
|
7164
|
+
:resource_arn,
|
7165
|
+
:tag_keys)
|
7166
|
+
include Aws::Structure
|
7167
|
+
end
|
7168
|
+
|
7169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UntagResourceResponse AWS API Documentation
|
7170
|
+
#
|
7171
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
7172
|
+
|
6637
7173
|
# Represents the input for a request action.
|
6638
7174
|
#
|
6639
7175
|
# @note When making an API call, you may pass UpdateAliasInput
|
@@ -6651,22 +7187,22 @@ module Aws::GameLift
|
|
6651
7187
|
# }
|
6652
7188
|
#
|
6653
7189
|
# @!attribute [rw] alias_id
|
6654
|
-
#
|
6655
|
-
#
|
7190
|
+
# A unique identifier for the alias that you want to update. You can
|
7191
|
+
# use either the alias ID or ARN value.
|
6656
7192
|
# @return [String]
|
6657
7193
|
#
|
6658
7194
|
# @!attribute [rw] name
|
6659
|
-
#
|
7195
|
+
# A descriptive label that is associated with an alias. Alias names do
|
6660
7196
|
# not need to be unique.
|
6661
7197
|
# @return [String]
|
6662
7198
|
#
|
6663
7199
|
# @!attribute [rw] description
|
6664
|
-
#
|
7200
|
+
# A human-readable description of the alias.
|
6665
7201
|
# @return [String]
|
6666
7202
|
#
|
6667
7203
|
# @!attribute [rw] routing_strategy
|
6668
|
-
#
|
6669
|
-
# alias.
|
7204
|
+
# The routing configuration, including routing type and fleet target,
|
7205
|
+
# for the alias.
|
6670
7206
|
# @return [Types::RoutingStrategy]
|
6671
7207
|
#
|
6672
7208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateAliasInput AWS API Documentation
|
@@ -6682,7 +7218,7 @@ module Aws::GameLift
|
|
6682
7218
|
# Represents the returned data in response to a request action.
|
6683
7219
|
#
|
6684
7220
|
# @!attribute [rw] alias
|
6685
|
-
#
|
7221
|
+
# The updated alias resource.
|
6686
7222
|
# @return [Types::Alias]
|
6687
7223
|
#
|
6688
7224
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateAliasOutput AWS API Documentation
|
@@ -6704,17 +7240,18 @@ module Aws::GameLift
|
|
6704
7240
|
# }
|
6705
7241
|
#
|
6706
7242
|
# @!attribute [rw] build_id
|
6707
|
-
#
|
7243
|
+
# A unique identifier for a build to update. You can use either the
|
7244
|
+
# build ID or ARN value.
|
6708
7245
|
# @return [String]
|
6709
7246
|
#
|
6710
7247
|
# @!attribute [rw] name
|
6711
|
-
#
|
7248
|
+
# A descriptive label that is associated with a build. Build names do
|
6712
7249
|
# not need to be unique.
|
6713
7250
|
# @return [String]
|
6714
7251
|
#
|
6715
7252
|
# @!attribute [rw] version
|
6716
|
-
# Version that is associated with a build or script.
|
6717
|
-
# do not need to be unique.
|
7253
|
+
# Version information that is associated with a build or script.
|
7254
|
+
# Version strings do not need to be unique.
|
6718
7255
|
# @return [String]
|
6719
7256
|
#
|
6720
7257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateBuildInput AWS API Documentation
|
@@ -6729,7 +7266,7 @@ module Aws::GameLift
|
|
6729
7266
|
# Represents the returned data in response to a request action.
|
6730
7267
|
#
|
6731
7268
|
# @!attribute [rw] build
|
6732
|
-
#
|
7269
|
+
# The updated build record.
|
6733
7270
|
# @return [Types::Build]
|
6734
7271
|
#
|
6735
7272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateBuildOutput AWS API Documentation
|
@@ -6757,11 +7294,12 @@ module Aws::GameLift
|
|
6757
7294
|
# }
|
6758
7295
|
#
|
6759
7296
|
# @!attribute [rw] fleet_id
|
6760
|
-
#
|
7297
|
+
# A unique identifier for a fleet to update attribute metadata for.
|
7298
|
+
# You can use either the fleet ID or ARN value.
|
6761
7299
|
# @return [String]
|
6762
7300
|
#
|
6763
7301
|
# @!attribute [rw] name
|
6764
|
-
#
|
7302
|
+
# A descriptive label that is associated with a fleet. Fleet names do
|
6765
7303
|
# not need to be unique.
|
6766
7304
|
# @return [String]
|
6767
7305
|
#
|
@@ -6809,7 +7347,8 @@ module Aws::GameLift
|
|
6809
7347
|
# Represents the returned data in response to a request action.
|
6810
7348
|
#
|
6811
7349
|
# @!attribute [rw] fleet_id
|
6812
|
-
#
|
7350
|
+
# A unique identifier for a fleet that was updated. Use either the
|
7351
|
+
# fleet ID or ARN value.
|
6813
7352
|
# @return [String]
|
6814
7353
|
#
|
6815
7354
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetAttributesOutput AWS API Documentation
|
@@ -6832,7 +7371,8 @@ module Aws::GameLift
|
|
6832
7371
|
# }
|
6833
7372
|
#
|
6834
7373
|
# @!attribute [rw] fleet_id
|
6835
|
-
#
|
7374
|
+
# A unique identifier for a fleet to update capacity for. You can use
|
7375
|
+
# either the fleet ID or ARN value.
|
6836
7376
|
# @return [String]
|
6837
7377
|
#
|
6838
7378
|
# @!attribute [rw] desired_instances
|
@@ -6840,13 +7380,13 @@ module Aws::GameLift
|
|
6840
7380
|
# @return [Integer]
|
6841
7381
|
#
|
6842
7382
|
# @!attribute [rw] min_size
|
6843
|
-
#
|
6844
|
-
# not set is 0.
|
7383
|
+
# The minimum value allowed for the fleet's instance count. Default
|
7384
|
+
# if not set is 0.
|
6845
7385
|
# @return [Integer]
|
6846
7386
|
#
|
6847
7387
|
# @!attribute [rw] max_size
|
6848
|
-
#
|
6849
|
-
# not set is 1.
|
7388
|
+
# The maximum value allowed for the fleet's instance count. Default
|
7389
|
+
# if not set is 1.
|
6850
7390
|
# @return [Integer]
|
6851
7391
|
#
|
6852
7392
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetCapacityInput AWS API Documentation
|
@@ -6862,7 +7402,7 @@ module Aws::GameLift
|
|
6862
7402
|
# Represents the returned data in response to a request action.
|
6863
7403
|
#
|
6864
7404
|
# @!attribute [rw] fleet_id
|
6865
|
-
#
|
7405
|
+
# A unique identifier for a fleet that was updated.
|
6866
7406
|
# @return [String]
|
6867
7407
|
#
|
6868
7408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetCapacityOutput AWS API Documentation
|
@@ -6898,15 +7438,16 @@ module Aws::GameLift
|
|
6898
7438
|
# }
|
6899
7439
|
#
|
6900
7440
|
# @!attribute [rw] fleet_id
|
6901
|
-
#
|
7441
|
+
# A unique identifier for a fleet to update port settings for. You can
|
7442
|
+
# use either the fleet ID or ARN value.
|
6902
7443
|
# @return [String]
|
6903
7444
|
#
|
6904
7445
|
# @!attribute [rw] inbound_permission_authorizations
|
6905
|
-
#
|
7446
|
+
# A collection of port settings to be added to the fleet record.
|
6906
7447
|
# @return [Array<Types::IpPermission>]
|
6907
7448
|
#
|
6908
7449
|
# @!attribute [rw] inbound_permission_revocations
|
6909
|
-
#
|
7450
|
+
# A collection of port settings to be removed from the fleet record.
|
6910
7451
|
# @return [Array<Types::IpPermission>]
|
6911
7452
|
#
|
6912
7453
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetPortSettingsInput AWS API Documentation
|
@@ -6921,7 +7462,7 @@ module Aws::GameLift
|
|
6921
7462
|
# Represents the returned data in response to a request action.
|
6922
7463
|
#
|
6923
7464
|
# @!attribute [rw] fleet_id
|
6924
|
-
#
|
7465
|
+
# A unique identifier for a fleet that was updated.
|
6925
7466
|
# @return [String]
|
6926
7467
|
#
|
6927
7468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetPortSettingsOutput AWS API Documentation
|
@@ -6945,16 +7486,16 @@ module Aws::GameLift
|
|
6945
7486
|
# }
|
6946
7487
|
#
|
6947
7488
|
# @!attribute [rw] game_session_id
|
6948
|
-
#
|
7489
|
+
# A unique identifier for the game session to update.
|
6949
7490
|
# @return [String]
|
6950
7491
|
#
|
6951
7492
|
# @!attribute [rw] maximum_player_session_count
|
6952
|
-
#
|
6953
|
-
# the game session.
|
7493
|
+
# The maximum number of players that can be connected simultaneously
|
7494
|
+
# to the game session.
|
6954
7495
|
# @return [Integer]
|
6955
7496
|
#
|
6956
7497
|
# @!attribute [rw] name
|
6957
|
-
#
|
7498
|
+
# A descriptive label that is associated with a game session. Session
|
6958
7499
|
# names do not need to be unique.
|
6959
7500
|
# @return [String]
|
6960
7501
|
#
|
@@ -6987,7 +7528,7 @@ module Aws::GameLift
|
|
6987
7528
|
# Represents the returned data in response to a request action.
|
6988
7529
|
#
|
6989
7530
|
# @!attribute [rw] game_session
|
6990
|
-
#
|
7531
|
+
# The updated game session metadata.
|
6991
7532
|
# @return [Types::GameSession]
|
6992
7533
|
#
|
6993
7534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSessionOutput AWS API Documentation
|
@@ -7019,31 +7560,33 @@ module Aws::GameLift
|
|
7019
7560
|
# }
|
7020
7561
|
#
|
7021
7562
|
# @!attribute [rw] name
|
7022
|
-
#
|
7023
|
-
# names must be unique within each
|
7563
|
+
# A descriptive label that is associated with game session queue.
|
7564
|
+
# Queue names must be unique within each Region. You can use either
|
7565
|
+
# the queue ID or ARN value.
|
7024
7566
|
# @return [String]
|
7025
7567
|
#
|
7026
7568
|
# @!attribute [rw] timeout_in_seconds
|
7027
|
-
#
|
7028
|
-
# remains in the queue. When a request exceeds this time, the
|
7029
|
-
# session placement changes to a `TIMED_OUT` status.
|
7569
|
+
# The maximum time, in seconds, that a new game session placement
|
7570
|
+
# request remains in the queue. When a request exceeds this time, the
|
7571
|
+
# game session placement changes to a `TIMED_OUT` status.
|
7030
7572
|
# @return [Integer]
|
7031
7573
|
#
|
7032
7574
|
# @!attribute [rw] player_latency_policies
|
7033
|
-
#
|
7575
|
+
# A collection of latency policies to apply when processing game
|
7034
7576
|
# sessions placement requests with player latency information.
|
7035
7577
|
# Multiple policies are evaluated in order of the maximum latency
|
7036
7578
|
# value, starting with the lowest latency values. With just one
|
7037
|
-
# policy,
|
7038
|
-
# for the duration period. With multiple policies, each
|
7039
|
-
# enforced consecutively for its duration period. For
|
7040
|
-
# might enforce a 60-second policy followed by a
|
7041
|
-
# and then no policy for the remainder of the
|
7042
|
-
# policies, provide a complete collection of
|
7579
|
+
# policy, the policy is enforced at the start of the game session
|
7580
|
+
# placement for the duration period. With multiple policies, each
|
7581
|
+
# policy is enforced consecutively for its duration period. For
|
7582
|
+
# example, a queue might enforce a 60-second policy followed by a
|
7583
|
+
# 120-second policy, and then no policy for the remainder of the
|
7584
|
+
# placement. When updating policies, provide a complete collection of
|
7585
|
+
# policies.
|
7043
7586
|
# @return [Array<Types::PlayerLatencyPolicy>]
|
7044
7587
|
#
|
7045
7588
|
# @!attribute [rw] destinations
|
7046
|
-
#
|
7589
|
+
# A list of fleets that can be used to fulfill game session placement
|
7047
7590
|
# requests in the queue. Fleets are identified by either a fleet ARN
|
7048
7591
|
# or a fleet alias ARN. Destinations are listed in default preference
|
7049
7592
|
# order. When updating this list, provide a complete list of
|
@@ -7063,7 +7606,7 @@ module Aws::GameLift
|
|
7063
7606
|
# Represents the returned data in response to a request action.
|
7064
7607
|
#
|
7065
7608
|
# @!attribute [rw] game_session_queue
|
7066
|
-
#
|
7609
|
+
# An object that describes the newly updated game session queue.
|
7067
7610
|
# @return [Types::GameSessionQueue]
|
7068
7611
|
#
|
7069
7612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameSessionQueueOutput AWS API Documentation
|
@@ -7079,13 +7622,13 @@ module Aws::GameLift
|
|
7079
7622
|
# data as a hash:
|
7080
7623
|
#
|
7081
7624
|
# {
|
7082
|
-
# name: "
|
7625
|
+
# name: "MatchmakingConfigurationName", # required
|
7083
7626
|
# description: "NonZeroAndMaxString",
|
7084
7627
|
# game_session_queue_arns: ["ArnStringModel"],
|
7085
7628
|
# request_timeout_seconds: 1,
|
7086
7629
|
# acceptance_timeout_seconds: 1,
|
7087
7630
|
# acceptance_required: false,
|
7088
|
-
# rule_set_name: "
|
7631
|
+
# rule_set_name: "MatchmakingRuleSetName",
|
7089
7632
|
# notification_target: "SnsArnStringModel",
|
7090
7633
|
# additional_player_count: 1,
|
7091
7634
|
# custom_event_data: "CustomEventData",
|
@@ -7100,54 +7643,57 @@ module Aws::GameLift
|
|
7100
7643
|
# }
|
7101
7644
|
#
|
7102
7645
|
# @!attribute [rw] name
|
7103
|
-
#
|
7646
|
+
# A unique identifier for a matchmaking configuration to update. You
|
7647
|
+
# can use either the configuration name or ARN value.
|
7104
7648
|
# @return [String]
|
7105
7649
|
#
|
7106
7650
|
# @!attribute [rw] description
|
7107
|
-
#
|
7651
|
+
# A descriptive label that is associated with matchmaking
|
7652
|
+
# configuration.
|
7108
7653
|
# @return [String]
|
7109
7654
|
#
|
7110
7655
|
# @!attribute [rw] game_session_queue_arns
|
7111
|
-
# Amazon Resource Name ([ARN][1]) that is assigned to a game
|
7112
|
-
# queue and uniquely identifies it.
|
7113
|
-
#
|
7114
|
-
#
|
7115
|
-
#
|
7116
|
-
# located in any region.
|
7656
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
7657
|
+
# session queue resource and uniquely identifies it. ARNs are unique
|
7658
|
+
# across all Regions. These queues are used when placing game sessions
|
7659
|
+
# for matches that are created with this matchmaking configuration.
|
7660
|
+
# Queues can be located in any Region.
|
7117
7661
|
#
|
7118
7662
|
#
|
7119
7663
|
#
|
7120
|
-
# [1]: https://docs.aws.amazon.com/
|
7664
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
7121
7665
|
# @return [Array<String>]
|
7122
7666
|
#
|
7123
7667
|
# @!attribute [rw] request_timeout_seconds
|
7124
|
-
#
|
7125
|
-
# in process before timing out. Requests that fail due to
|
7126
|
-
# can be resubmitted as needed.
|
7668
|
+
# The maximum duration, in seconds, that a matchmaking ticket can
|
7669
|
+
# remain in process before timing out. Requests that fail due to
|
7670
|
+
# timing out can be resubmitted as needed.
|
7127
7671
|
# @return [Integer]
|
7128
7672
|
#
|
7129
7673
|
# @!attribute [rw] acceptance_timeout_seconds
|
7130
|
-
#
|
7131
|
-
# match. If any player rejects the match or fails to accept
|
7132
|
-
# timeout, the ticket continues to look for an acceptable
|
7674
|
+
# The length of time (in seconds) to wait for players to accept a
|
7675
|
+
# proposed match. If any player rejects the match or fails to accept
|
7676
|
+
# before the timeout, the ticket continues to look for an acceptable
|
7677
|
+
# match.
|
7133
7678
|
# @return [Integer]
|
7134
7679
|
#
|
7135
7680
|
# @!attribute [rw] acceptance_required
|
7136
|
-
#
|
7681
|
+
# A flag that indicates whether a match that was created with this
|
7137
7682
|
# configuration must be accepted by the matched players. To require
|
7138
7683
|
# acceptance, set to TRUE.
|
7139
7684
|
# @return [Boolean]
|
7140
7685
|
#
|
7141
7686
|
# @!attribute [rw] rule_set_name
|
7142
|
-
#
|
7143
|
-
# configuration.
|
7144
|
-
# that are defined in
|
7687
|
+
# A unique identifier for a matchmaking rule set to use with this
|
7688
|
+
# configuration. You can use either the rule set name or ARN value. A
|
7689
|
+
# matchmaking configuration can only use rule sets that are defined in
|
7690
|
+
# the same Region.
|
7145
7691
|
# @return [String]
|
7146
7692
|
#
|
7147
7693
|
# @!attribute [rw] notification_target
|
7148
|
-
# SNS topic ARN that is set up to receive matchmaking
|
7149
|
-
# See [ Setting up Notifications for Matchmaking][1]
|
7150
|
-
# information.
|
7694
|
+
# An SNS topic ARN that is set up to receive matchmaking
|
7695
|
+
# notifications. See [ Setting up Notifications for Matchmaking][1]
|
7696
|
+
# for more information.
|
7151
7697
|
#
|
7152
7698
|
#
|
7153
7699
|
#
|
@@ -7155,10 +7701,11 @@ module Aws::GameLift
|
|
7155
7701
|
# @return [String]
|
7156
7702
|
#
|
7157
7703
|
# @!attribute [rw] additional_player_count
|
7158
|
-
#
|
7159
|
-
# For example,
|
7160
|
-
# a single 12-person team
|
7161
|
-
# 2, only 10 players are selected for
|
7704
|
+
# The number of player slots in a match to keep open for future
|
7705
|
+
# players. For example, assume that the configuration's rule set
|
7706
|
+
# specifies a match for a single 12-person team. If the additional
|
7707
|
+
# player count is set to 2, only 10 players are initially selected for
|
7708
|
+
# the match.
|
7162
7709
|
# @return [Integer]
|
7163
7710
|
#
|
7164
7711
|
# @!attribute [rw] custom_event_data
|
@@ -7167,11 +7714,12 @@ module Aws::GameLift
|
|
7167
7714
|
# @return [String]
|
7168
7715
|
#
|
7169
7716
|
# @!attribute [rw] game_properties
|
7170
|
-
#
|
7171
|
-
# pairs. These properties are passed to a game server
|
7172
|
-
# GameSession object with a request to start a new game
|
7173
|
-
# [Start a Game Session][1]). This information is added
|
7174
|
-
# GameSession object that is created for a successful
|
7717
|
+
# A set of custom properties for a game session, formatted as
|
7718
|
+
# key-value pairs. These properties are passed to a game server
|
7719
|
+
# process in the GameSession object with a request to start a new game
|
7720
|
+
# session (see [Start a Game Session][1]). This information is added
|
7721
|
+
# to the new GameSession object that is created for a successful
|
7722
|
+
# match.
|
7175
7723
|
#
|
7176
7724
|
#
|
7177
7725
|
#
|
@@ -7179,8 +7727,8 @@ module Aws::GameLift
|
|
7179
7727
|
# @return [Array<Types::GameProperty>]
|
7180
7728
|
#
|
7181
7729
|
# @!attribute [rw] game_session_data
|
7182
|
-
#
|
7183
|
-
# value. This data is passed to a game server process in the
|
7730
|
+
# A set of custom game session properties, formatted as a single
|
7731
|
+
# string value. This data is passed to a game server process in the
|
7184
7732
|
# GameSession object with a request to start a new game session (see
|
7185
7733
|
# [Start a Game Session][1]). This information is added to the new
|
7186
7734
|
# GameSession object that is created for a successful match.
|
@@ -7191,13 +7739,13 @@ module Aws::GameLift
|
|
7191
7739
|
# @return [String]
|
7192
7740
|
#
|
7193
7741
|
# @!attribute [rw] backfill_mode
|
7194
|
-
#
|
7195
|
-
# configuration. Specify MANUAL when your game manages
|
7196
|
-
# requests manually or does not use the match backfill
|
7197
|
-
# Specify AUTOMATIC to have GameLift create a
|
7198
|
-
# request whenever a game session has one or more
|
7199
|
-
# more about manual and automatic backfill in
|
7200
|
-
# with FlexMatch][1].
|
7742
|
+
# The method that is used to backfill game sessions created with this
|
7743
|
+
# matchmaking configuration. Specify MANUAL when your game manages
|
7744
|
+
# backfill requests manually or does not use the match backfill
|
7745
|
+
# feature. Specify AUTOMATIC to have GameLift create a
|
7746
|
+
# StartMatchBackfill request whenever a game session has one or more
|
7747
|
+
# open slots. Learn more about manual and automatic backfill in
|
7748
|
+
# [Backfill Existing Games with FlexMatch][1].
|
7201
7749
|
#
|
7202
7750
|
#
|
7203
7751
|
#
|
@@ -7226,7 +7774,7 @@ module Aws::GameLift
|
|
7226
7774
|
# Represents the returned data in response to a request action.
|
7227
7775
|
#
|
7228
7776
|
# @!attribute [rw] configuration
|
7229
|
-
#
|
7777
|
+
# The updated matchmaking configuration.
|
7230
7778
|
# @return [Types::MatchmakingConfiguration]
|
7231
7779
|
#
|
7232
7780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfigurationOutput AWS API Documentation
|
@@ -7257,19 +7805,19 @@ module Aws::GameLift
|
|
7257
7805
|
# }
|
7258
7806
|
#
|
7259
7807
|
# @!attribute [rw] fleet_id
|
7260
|
-
#
|
7808
|
+
# A unique identifier for a fleet to update runtime configuration for.
|
7809
|
+
# You can use either the fleet ID or ARN value.
|
7261
7810
|
# @return [String]
|
7262
7811
|
#
|
7263
7812
|
# @!attribute [rw] runtime_configuration
|
7264
7813
|
# Instructions for launching server processes on each instance in the
|
7265
7814
|
# fleet. Server processes run either a custom game build executable or
|
7266
|
-
# a Realtime Servers script. The
|
7267
|
-
#
|
7268
|
-
#
|
7269
|
-
#
|
7270
|
-
#
|
7271
|
-
#
|
7272
|
-
# configuration.
|
7815
|
+
# a Realtime Servers script. The runtime configuration lists the types
|
7816
|
+
# of server processes to run on an instance and includes the following
|
7817
|
+
# configuration settings: the server executable or launch script file,
|
7818
|
+
# launch parameters, and the number of processes to run concurrently
|
7819
|
+
# on each instance. A CreateFleet request must include a runtime
|
7820
|
+
# configuration with at least one server process configuration.
|
7273
7821
|
# @return [Types::RuntimeConfiguration]
|
7274
7822
|
#
|
7275
7823
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateRuntimeConfigurationInput AWS API Documentation
|
@@ -7283,7 +7831,7 @@ module Aws::GameLift
|
|
7283
7831
|
# Represents the returned data in response to a request action.
|
7284
7832
|
#
|
7285
7833
|
# @!attribute [rw] runtime_configuration
|
7286
|
-
# The
|
7834
|
+
# The runtime configuration currently in force. If the update was
|
7287
7835
|
# successful, this object matches the one in the request.
|
7288
7836
|
# @return [Types::RuntimeConfiguration]
|
7289
7837
|
#
|
@@ -7311,25 +7859,26 @@ module Aws::GameLift
|
|
7311
7859
|
# }
|
7312
7860
|
#
|
7313
7861
|
# @!attribute [rw] script_id
|
7314
|
-
#
|
7862
|
+
# A unique identifier for a Realtime script to update. You can use
|
7863
|
+
# either the script ID or ARN value.
|
7315
7864
|
# @return [String]
|
7316
7865
|
#
|
7317
7866
|
# @!attribute [rw] name
|
7318
|
-
#
|
7319
|
-
# not need to be unique.
|
7867
|
+
# A descriptive label that is associated with a script. Script names
|
7868
|
+
# do not need to be unique.
|
7320
7869
|
# @return [String]
|
7321
7870
|
#
|
7322
7871
|
# @!attribute [rw] version
|
7323
|
-
#
|
7324
|
-
# do not need to be unique.
|
7872
|
+
# The version that is associated with a build or script. Version
|
7873
|
+
# strings do not need to be unique.
|
7325
7874
|
# @return [String]
|
7326
7875
|
#
|
7327
7876
|
# @!attribute [rw] storage_location
|
7328
|
-
#
|
7329
|
-
# Realtime scripts is stored. The storage location must specify
|
7330
|
-
# Amazon S3 bucket name, the zip file name (the "key"), and a
|
7331
|
-
# ARN that allows Amazon GameLift to access the Amazon S3 storage
|
7332
|
-
# location. The S3 bucket must be in the same
|
7877
|
+
# The location of the Amazon S3 bucket where a zipped file containing
|
7878
|
+
# your Realtime scripts is stored. The storage location must specify
|
7879
|
+
# the Amazon S3 bucket name, the zip file name (the "key"), and a
|
7880
|
+
# role ARN that allows Amazon GameLift to access the Amazon S3 storage
|
7881
|
+
# location. The S3 bucket must be in the same Region where you want to
|
7333
7882
|
# create a new script. By default, Amazon GameLift uploads the latest
|
7334
7883
|
# version of the zip file; if you have S3 object versioning turned on,
|
7335
7884
|
# you can use the `ObjectVersion` parameter to specify an earlier
|
@@ -7337,7 +7886,7 @@ module Aws::GameLift
|
|
7337
7886
|
# @return [Types::S3Location]
|
7338
7887
|
#
|
7339
7888
|
# @!attribute [rw] zip_file
|
7340
|
-
#
|
7889
|
+
# A data object containing your Realtime scripts and dependencies as a
|
7341
7890
|
# zip file. The zip file can have one or multiple files. Maximum size
|
7342
7891
|
# of a zip file is 5 MB.
|
7343
7892
|
#
|
@@ -7385,7 +7934,7 @@ module Aws::GameLift
|
|
7385
7934
|
# }
|
7386
7935
|
#
|
7387
7936
|
# @!attribute [rw] rule_set_body
|
7388
|
-
#
|
7937
|
+
# A collection of matchmaking rules to validate, formatted as a JSON
|
7389
7938
|
# string.
|
7390
7939
|
# @return [String]
|
7391
7940
|
#
|
@@ -7399,7 +7948,7 @@ module Aws::GameLift
|
|
7399
7948
|
# Represents the returned data in response to a request action.
|
7400
7949
|
#
|
7401
7950
|
# @!attribute [rw] valid
|
7402
|
-
#
|
7951
|
+
# A response indicating whether the rule set is valid.
|
7403
7952
|
# @return [Boolean]
|
7404
7953
|
#
|
7405
7954
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ValidateMatchmakingRuleSetOutput AWS API Documentation
|
@@ -7428,7 +7977,7 @@ module Aws::GameLift
|
|
7428
7977
|
# * DeleteVpcPeeringConnection
|
7429
7978
|
#
|
7430
7979
|
# @!attribute [rw] game_lift_aws_account_id
|
7431
|
-
#
|
7980
|
+
# A unique identifier for the AWS account that you use to manage your
|
7432
7981
|
# Amazon GameLift fleet. You can find your Account ID in the AWS
|
7433
7982
|
# Management Console under account settings.
|
7434
7983
|
# @return [String]
|
@@ -7437,8 +7986,8 @@ module Aws::GameLift
|
|
7437
7986
|
# @return [String]
|
7438
7987
|
#
|
7439
7988
|
# @!attribute [rw] peer_vpc_id
|
7440
|
-
#
|
7441
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
7989
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
7990
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
7442
7991
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
7443
7992
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
7444
7993
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -7490,10 +8039,19 @@ module Aws::GameLift
|
|
7490
8039
|
# * DeleteVpcPeeringConnection
|
7491
8040
|
#
|
7492
8041
|
# @!attribute [rw] fleet_id
|
7493
|
-
#
|
8042
|
+
# A unique identifier for a fleet. This ID determines the ID of the
|
7494
8043
|
# Amazon GameLift VPC for your fleet.
|
7495
8044
|
# @return [String]
|
7496
8045
|
#
|
8046
|
+
# @!attribute [rw] fleet_arn
|
8047
|
+
# The Amazon Resource Name ([ARN][1]) associated with the GameLift
|
8048
|
+
# fleet resource for this connection.
|
8049
|
+
#
|
8050
|
+
#
|
8051
|
+
#
|
8052
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
8053
|
+
# @return [String]
|
8054
|
+
#
|
7497
8055
|
# @!attribute [rw] ip_v4_cidr_block
|
7498
8056
|
# CIDR block of IPv4 addresses assigned to the VPC peering connection
|
7499
8057
|
# for the GameLift VPC. The peered VPC also has an IPv4 CIDR block
|
@@ -7502,19 +8060,19 @@ module Aws::GameLift
|
|
7502
8060
|
# @return [String]
|
7503
8061
|
#
|
7504
8062
|
# @!attribute [rw] vpc_peering_connection_id
|
7505
|
-
#
|
8063
|
+
# A unique identifier that is automatically assigned to the connection
|
7506
8064
|
# record. This ID is referenced in VPC peering connection events, and
|
7507
8065
|
# is used when deleting a connection with DeleteVpcPeeringConnection.
|
7508
8066
|
# @return [String]
|
7509
8067
|
#
|
7510
8068
|
# @!attribute [rw] status
|
7511
|
-
#
|
7512
|
-
#
|
8069
|
+
# The status information about the connection. Status indicates if a
|
8070
|
+
# connection is pending, successful, or failed.
|
7513
8071
|
# @return [Types::VpcPeeringConnectionStatus]
|
7514
8072
|
#
|
7515
8073
|
# @!attribute [rw] peer_vpc_id
|
7516
|
-
#
|
7517
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
8074
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
8075
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
7518
8076
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
7519
8077
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
7520
8078
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -7526,7 +8084,7 @@ module Aws::GameLift
|
|
7526
8084
|
# @return [String]
|
7527
8085
|
#
|
7528
8086
|
# @!attribute [rw] game_lift_vpc_id
|
7529
|
-
#
|
8087
|
+
# A unique identifier for the VPC that contains the Amazon GameLift
|
7530
8088
|
# fleet for this connection. This VPC is managed by Amazon GameLift
|
7531
8089
|
# and does not appear in your AWS account.
|
7532
8090
|
# @return [String]
|
@@ -7535,6 +8093,7 @@ module Aws::GameLift
|
|
7535
8093
|
#
|
7536
8094
|
class VpcPeeringConnection < Struct.new(
|
7537
8095
|
:fleet_id,
|
8096
|
+
:fleet_arn,
|
7538
8097
|
:ip_v4_cidr_block,
|
7539
8098
|
:vpc_peering_connection_id,
|
7540
8099
|
:status,
|