aws-sdk-gamelift 1.26.0 → 1.27.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 333944a6eb7c6464927b19e065918a244f209679
|
4
|
+
data.tar.gz: 0debdbaff05ab856773f893bce63ed276622303e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ee8e1fc7e3f9fd6f1389db008f4dc3594fee1f1b71aa8ea745750b574cb7ca83daaf92f8a4c2fb74d199d43d11e9f8d3ba5a7910df3f47228c81aff6c6eb99e7
|
7
|
+
data.tar.gz: 6f7976cdb0f296dd5131d04360c18fef60523ce0398e948fe5b7d0be0d0f57bc8f22510c1ae218e9682fd813dfb88dc819fa16b0b726f2baec713af09e6dc5aa
|
data/lib/aws-sdk-gamelift.rb
CHANGED
@@ -314,12 +314,12 @@ module Aws::GameLift
|
|
314
314
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-events.html
|
315
315
|
#
|
316
316
|
# @option params [required, String] :ticket_id
|
317
|
-
#
|
317
|
+
# A unique identifier for a matchmaking ticket. The ticket must be in
|
318
318
|
# status `REQUIRES_ACCEPTANCE`; otherwise this request will fail.
|
319
319
|
#
|
320
320
|
# @option params [required, Array<String>] :player_ids
|
321
|
-
#
|
322
|
-
# can include one or multiple player IDs.
|
321
|
+
# A unique identifier for a player delivering the response. This
|
322
|
+
# parameter can include one or multiple player IDs.
|
323
323
|
#
|
324
324
|
# @option params [required, String] :acceptance_type
|
325
325
|
# Player response to the proposed match.
|
@@ -344,11 +344,9 @@ module Aws::GameLift
|
|
344
344
|
end
|
345
345
|
|
346
346
|
# Creates an alias for a fleet. In most situations, you can use an alias
|
347
|
-
# ID in place of a fleet ID.
|
348
|
-
#
|
349
|
-
#
|
350
|
-
# example, for games in production, using an alias allows you to
|
351
|
-
# seamlessly redirect your player base to a new game server update.
|
347
|
+
# ID in place of a fleet ID. An alias provides a level of abstraction
|
348
|
+
# for a fleet that is useful when redirecting player traffic from one
|
349
|
+
# fleet to another, such as when updating your game build.
|
352
350
|
#
|
353
351
|
# Amazon GameLift supports two types of routing strategies for aliases:
|
354
352
|
# simple and terminal. A simple alias points to an active fleet. A
|
@@ -360,9 +358,8 @@ module Aws::GameLift
|
|
360
358
|
# To create a fleet alias, specify an alias name, routing strategy, and
|
361
359
|
# optional description. Each simple alias can point to only one fleet,
|
362
360
|
# but a fleet can have multiple aliases. If successful, a new alias
|
363
|
-
# record is returned, including an alias ID
|
364
|
-
#
|
365
|
-
# fleet by calling `UpdateAlias`.
|
361
|
+
# record is returned, including an alias ID and an ARN. You can reassign
|
362
|
+
# an alias to another fleet by calling `UpdateAlias`.
|
366
363
|
#
|
367
364
|
# * CreateAlias
|
368
365
|
#
|
@@ -377,14 +374,29 @@ module Aws::GameLift
|
|
377
374
|
# * ResolveAlias
|
378
375
|
#
|
379
376
|
# @option params [required, String] :name
|
380
|
-
#
|
381
|
-
# need to be unique.
|
377
|
+
# A descriptive label that is associated with an alias. Alias names do
|
378
|
+
# not need to be unique.
|
382
379
|
#
|
383
380
|
# @option params [String] :description
|
384
|
-
#
|
381
|
+
# A human-readable description of the alias.
|
385
382
|
#
|
386
383
|
# @option params [required, Types::RoutingStrategy] :routing_strategy
|
387
|
-
#
|
384
|
+
# The routing configuration, including routing type and fleet target,
|
385
|
+
# for the alias.
|
386
|
+
#
|
387
|
+
# @option params [Array<Types::Tag>] :tags
|
388
|
+
# A list of labels to assign to the new alias resource. Tags are
|
389
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
390
|
+
# for resource management, access management and cost allocation. For
|
391
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
392
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
393
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
394
|
+
# The maximum tag limit may be lower than stated. See the AWS General
|
395
|
+
# Reference for actual tagging limits.
|
396
|
+
#
|
397
|
+
#
|
398
|
+
#
|
399
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
388
400
|
#
|
389
401
|
# @return [Types::CreateAliasOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
390
402
|
#
|
@@ -400,6 +412,12 @@ module Aws::GameLift
|
|
400
412
|
# fleet_id: "FleetId",
|
401
413
|
# message: "FreeText",
|
402
414
|
# },
|
415
|
+
# tags: [
|
416
|
+
# {
|
417
|
+
# key: "TagKey", # required
|
418
|
+
# value: "TagValue", # required
|
419
|
+
# },
|
420
|
+
# ],
|
403
421
|
# })
|
404
422
|
#
|
405
423
|
# @example Response structure
|
@@ -427,34 +445,33 @@ module Aws::GameLift
|
|
427
445
|
# files and points to the location of your game server build files in an
|
428
446
|
# Amazon Simple Storage Service (Amazon S3) location.
|
429
447
|
#
|
430
|
-
# Game server binaries must be combined into a
|
448
|
+
# Game server binaries must be combined into a zip file for use with
|
431
449
|
# Amazon GameLift.
|
432
450
|
#
|
433
|
-
# To create new builds
|
434
|
-
# <a
|
451
|
+
# To create new builds directly from a file directory, use the AWS CLI
|
452
|
+
# command <b> <a
|
435
453
|
# href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
436
|
-
# </b>. This helper command uploads
|
454
|
+
# </b>. This helper command uploads build files and creates a new build
|
437
455
|
# record in one step, and automatically handles the necessary
|
438
456
|
# permissions.
|
439
457
|
#
|
440
|
-
# The `CreateBuild` operation should be used only
|
441
|
-
#
|
458
|
+
# The `CreateBuild` operation should be used only in the following
|
459
|
+
# scenarios:
|
442
460
|
#
|
443
|
-
# *
|
444
|
-
# account. To use this option, you must
|
445
|
-
# access to that Amazon S3 bucket.
|
446
|
-
#
|
447
|
-
#
|
448
|
-
# build.
|
461
|
+
# * To create a new game build with build files that are in an Amazon S3
|
462
|
+
# bucket under your own AWS account. To use this option, you must
|
463
|
+
# first give Amazon GameLift access to that Amazon S3 bucket. Then
|
464
|
+
# call `CreateBuild` and specify a build name, operating system, and
|
465
|
+
# the Amazon S3 storage location of your game build.
|
449
466
|
#
|
450
|
-
# *
|
451
|
-
# account. To use this option,
|
467
|
+
# * To upload build files directly to Amazon GameLift's Amazon S3
|
468
|
+
# account. To use this option, first call `CreateBuild` and specify a
|
452
469
|
# build name and operating system. This action creates a new build
|
453
470
|
# record and returns an Amazon S3 storage location (bucket and key
|
454
471
|
# only) and temporary access credentials. Use the credentials to
|
455
|
-
# manually upload your build file to the storage location
|
456
|
-
# Amazon S3 topic [Uploading Objects][1]). You can upload
|
457
|
-
# location only once.
|
472
|
+
# manually upload your build file to the provided storage location
|
473
|
+
# (see the Amazon S3 topic [Uploading Objects][1]). You can upload
|
474
|
+
# build files to the GameLift Amazon S3 location only once.
|
458
475
|
#
|
459
476
|
# If successful, this operation creates a new build record with a unique
|
460
477
|
# build ID and places it in `INITIALIZED` status. You can use
|
@@ -464,8 +481,9 @@ module Aws::GameLift
|
|
464
481
|
# **Learn more**
|
465
482
|
#
|
466
483
|
# [Uploading Your Game][2]
|
484
|
+
# [https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html][3]
|
467
485
|
#
|
468
|
-
# [ Create a Build with Files in Amazon S3][
|
486
|
+
# [ Create a Build with Files in Amazon S3][4]
|
469
487
|
#
|
470
488
|
# **Related operations**
|
471
489
|
#
|
@@ -483,34 +501,49 @@ module Aws::GameLift
|
|
483
501
|
#
|
484
502
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html
|
485
503
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
486
|
-
# [3]: https://docs.aws.amazon.com/
|
504
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
505
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
487
506
|
#
|
488
507
|
# @option params [String] :name
|
489
|
-
#
|
490
|
-
# need to be unique. You can use UpdateBuild to change this value later.
|
491
|
-
#
|
492
|
-
# @option params [String] :version
|
493
|
-
# Version that is associated with a build or script. Version strings do
|
508
|
+
# A descriptive label that is associated with a build. Build names do
|
494
509
|
# not need to be unique. You can use UpdateBuild to change this value
|
495
510
|
# later.
|
496
511
|
#
|
512
|
+
# @option params [String] :version
|
513
|
+
# Version information that is associated with a build or script. Version
|
514
|
+
# strings do not need to be unique. You can use UpdateBuild to change
|
515
|
+
# this value later.
|
516
|
+
#
|
497
517
|
# @option params [Types::S3Location] :storage_location
|
498
518
|
# Information indicating where your game build files are stored. Use
|
499
519
|
# this parameter only when creating a build with files stored in an
|
500
520
|
# Amazon S3 bucket that you own. The storage location must specify an
|
501
|
-
# Amazon S3 bucket name and key
|
502
|
-
# you set up to allow Amazon GameLift to access your Amazon S3
|
503
|
-
# The S3 bucket must be in the same
|
504
|
-
# build in.
|
521
|
+
# Amazon S3 bucket name and key. The location must also specify a role
|
522
|
+
# ARN that you set up to allow Amazon GameLift to access your Amazon S3
|
523
|
+
# bucket. The S3 bucket and your new build must be in the same Region.
|
505
524
|
#
|
506
525
|
# @option params [String] :operating_system
|
507
|
-
#
|
508
|
-
# This value determines the type of fleet resources that you can use
|
509
|
-
# this build. If your game build contains multiple executables, they
|
510
|
-
# must run on the same operating system. If an operating system is
|
511
|
-
# specified when creating a build, Amazon GameLift uses the default
|
526
|
+
# The operating system that the game server binaries are built to run
|
527
|
+
# on. This value determines the type of fleet resources that you can use
|
528
|
+
# for this build. If your game build contains multiple executables, they
|
529
|
+
# all must run on the same operating system. If an operating system is
|
530
|
+
# not specified when creating a build, Amazon GameLift uses the default
|
512
531
|
# value (WINDOWS\_2012). This value cannot be changed later.
|
513
532
|
#
|
533
|
+
# @option params [Array<Types::Tag>] :tags
|
534
|
+
# A list of labels to assign to the new build resource. Tags are
|
535
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
536
|
+
# for resource management, access management and cost allocation. For
|
537
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
538
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
539
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
540
|
+
# The maximum tag limit may be lower than stated. See the AWS General
|
541
|
+
# Reference for actual tagging limits.
|
542
|
+
#
|
543
|
+
#
|
544
|
+
#
|
545
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
546
|
+
#
|
514
547
|
# @return [Types::CreateBuildOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
515
548
|
#
|
516
549
|
# * {Types::CreateBuildOutput#build #build} => Types::Build
|
@@ -529,11 +562,18 @@ module Aws::GameLift
|
|
529
562
|
# object_version: "NonEmptyString",
|
530
563
|
# },
|
531
564
|
# operating_system: "WINDOWS_2012", # accepts WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2
|
565
|
+
# tags: [
|
566
|
+
# {
|
567
|
+
# key: "TagKey", # required
|
568
|
+
# value: "TagValue", # required
|
569
|
+
# },
|
570
|
+
# ],
|
532
571
|
# })
|
533
572
|
#
|
534
573
|
# @example Response structure
|
535
574
|
#
|
536
575
|
# resp.build.build_id #=> String
|
576
|
+
# resp.build.build_arn #=> String
|
537
577
|
# resp.build.name #=> String
|
538
578
|
# resp.build.version #=> String
|
539
579
|
# resp.build.status #=> String, one of "INITIALIZED", "READY", "FAILED"
|
@@ -567,17 +607,9 @@ module Aws::GameLift
|
|
567
607
|
# To create a new fleet, you must provide the following: (1) a fleet
|
568
608
|
# name, (2) an EC2 instance type and fleet type (spot or on-demand), (3)
|
569
609
|
# the build ID for your game build or script ID if using Realtime
|
570
|
-
# Servers, and (4) a
|
610
|
+
# Servers, and (4) a runtime configuration, which determines how game
|
571
611
|
# servers will run on each instance in the fleet.
|
572
612
|
#
|
573
|
-
# <note markdown="1"> When creating a Realtime Servers fleet, we recommend using a minimal
|
574
|
-
# version of the Realtime script (see this [ working code example ][1]).
|
575
|
-
# This will make it much easier to troubleshoot any fleet creation
|
576
|
-
# issues. Once the fleet is active, you can update your Realtime script
|
577
|
-
# as needed.
|
578
|
-
#
|
579
|
-
# </note>
|
580
|
-
#
|
581
613
|
# If the `CreateFleet` call is successful, Amazon GameLift performs the
|
582
614
|
# following tasks. You can track the process of a fleet by checking the
|
583
615
|
# fleet status or by monitoring fleet creation events:
|
@@ -587,7 +619,7 @@ module Aws::GameLift
|
|
587
619
|
# * Begins writing events to the fleet event log, which can be accessed
|
588
620
|
# in the Amazon GameLift console.
|
589
621
|
#
|
590
|
-
#
|
622
|
+
# * Sets the fleet's target capacity to 1 (desired instances), which
|
591
623
|
# triggers Amazon GameLift to start one new EC2 instance.
|
592
624
|
#
|
593
625
|
# * Downloads the game build or Realtime script to the new instance and
|
@@ -595,7 +627,7 @@ module Aws::GameLift
|
|
595
627
|
#
|
596
628
|
# * Starts launching server processes on the instance. If the fleet is
|
597
629
|
# configured to run multiple server processes per instance, Amazon
|
598
|
-
# GameLift staggers each launch by a few seconds. Status:
|
630
|
+
# GameLift staggers each process launch by a few seconds. Status:
|
599
631
|
# `ACTIVATING`.
|
600
632
|
#
|
601
633
|
# * Sets the fleet's status to `ACTIVE` as soon as one server process
|
@@ -603,9 +635,9 @@ module Aws::GameLift
|
|
603
635
|
#
|
604
636
|
# **Learn more**
|
605
637
|
#
|
606
|
-
# [
|
638
|
+
# [ Setting Up Fleets][1]
|
607
639
|
#
|
608
|
-
# [ Debug Fleet Creation Issues][
|
640
|
+
# [ Debug Fleet Creation Issues][2]
|
609
641
|
#
|
610
642
|
# **Related operations**
|
611
643
|
#
|
@@ -615,31 +647,9 @@ module Aws::GameLift
|
|
615
647
|
#
|
616
648
|
# * DeleteFleet
|
617
649
|
#
|
618
|
-
# *
|
619
|
-
#
|
620
|
-
# * DescribeFleetAttributes
|
621
|
-
#
|
622
|
-
# * DescribeFleetCapacity
|
623
|
-
#
|
624
|
-
# * DescribeFleetPortSettings
|
625
|
-
#
|
626
|
-
# * DescribeFleetUtilization
|
627
|
-
#
|
628
|
-
# * DescribeRuntimeConfiguration
|
629
|
-
#
|
630
|
-
# * DescribeEC2InstanceLimits
|
631
|
-
#
|
632
|
-
# * DescribeFleetEvents
|
650
|
+
# * DescribeFleetAttributes
|
633
651
|
#
|
634
|
-
# *
|
635
|
-
#
|
636
|
-
# * UpdateFleetAttributes
|
637
|
-
#
|
638
|
-
# * UpdateFleetCapacity
|
639
|
-
#
|
640
|
-
# * UpdateFleetPortSettings
|
641
|
-
#
|
642
|
-
# * UpdateRuntimeConfiguration
|
652
|
+
# * UpdateFleetAttributes
|
643
653
|
#
|
644
654
|
# * Manage fleet actions:
|
645
655
|
#
|
@@ -649,40 +659,40 @@ module Aws::GameLift
|
|
649
659
|
#
|
650
660
|
#
|
651
661
|
#
|
652
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
653
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-
|
654
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
662
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
663
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation
|
655
664
|
#
|
656
665
|
# @option params [required, String] :name
|
657
|
-
#
|
658
|
-
# need to be unique.
|
666
|
+
# A descriptive label that is associated with a fleet. Fleet names do
|
667
|
+
# not need to be unique.
|
659
668
|
#
|
660
669
|
# @option params [String] :description
|
661
|
-
#
|
670
|
+
# A human-readable description of a fleet.
|
662
671
|
#
|
663
672
|
# @option params [String] :build_id
|
664
|
-
#
|
665
|
-
#
|
666
|
-
# Amazon GameLift and be in a
|
667
|
-
# be changed once the fleet is
|
673
|
+
# A unique identifier for a build to be deployed on the new fleet. You
|
674
|
+
# can use either the build ID or ARN value. The custom game server build
|
675
|
+
# must have been successfully uploaded to Amazon GameLift and be in a
|
676
|
+
# `READY` status. This fleet setting cannot be changed once the fleet is
|
677
|
+
# created.
|
668
678
|
#
|
669
679
|
# @option params [String] :script_id
|
670
|
-
#
|
671
|
-
# fleet.
|
672
|
-
#
|
673
|
-
# is created.
|
680
|
+
# A unique identifier for a Realtime script to be deployed on the new
|
681
|
+
# fleet. You can use either the script ID or ARN value. The Realtime
|
682
|
+
# script must have been successfully uploaded to Amazon GameLift. This
|
683
|
+
# fleet setting cannot be changed once the fleet is created.
|
674
684
|
#
|
675
685
|
# @option params [String] :server_launch_path
|
676
686
|
# This parameter is no longer used. Instead, specify a server launch
|
677
|
-
# path using the `RuntimeConfiguration` parameter.
|
678
|
-
#
|
679
|
-
#
|
687
|
+
# path using the `RuntimeConfiguration` parameter. Requests that specify
|
688
|
+
# a server launch path and launch parameters instead of a runtime
|
689
|
+
# configuration will continue to work.
|
680
690
|
#
|
681
691
|
# @option params [String] :server_launch_parameters
|
682
692
|
# This parameter is no longer used. Instead, specify server launch
|
683
693
|
# parameters in the `RuntimeConfiguration` parameter. (Requests that
|
684
694
|
# specify a server launch path and launch parameters instead of a
|
685
|
-
#
|
695
|
+
# runtime configuration will continue to work.)
|
686
696
|
#
|
687
697
|
# @option params [Array<String>] :log_paths
|
688
698
|
# This parameter is no longer used. Instead, to specify where Amazon
|
@@ -696,8 +706,8 @@ module Aws::GameLift
|
|
696
706
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process
|
697
707
|
#
|
698
708
|
# @option params [required, String] :ec2_instance_type
|
699
|
-
#
|
700
|
-
# fleet instance type determines the computing resources of each
|
709
|
+
# The name of an EC2 instance type that is supported in Amazon GameLift.
|
710
|
+
# A fleet instance type determines the computing resources of each
|
701
711
|
# instance in the fleet, including CPU, memory, storage, and networking
|
702
712
|
# capacity. Amazon GameLift supports the following EC2 instance types.
|
703
713
|
# See [Amazon EC2 Instance Types][1] for detailed descriptions.
|
@@ -708,7 +718,7 @@ module Aws::GameLift
|
|
708
718
|
#
|
709
719
|
# @option params [Array<Types::IpPermission>] :ec2_inbound_permissions
|
710
720
|
# Range of IP addresses and port settings that permit inbound traffic to
|
711
|
-
# access game sessions that running on the fleet. For fleets using a
|
721
|
+
# access game sessions that are running on the fleet. For fleets using a
|
712
722
|
# custom game build, this parameter is required before game sessions
|
713
723
|
# running on the fleet can accept connections. For Realtime Servers
|
714
724
|
# fleets, Amazon GameLift automatically sets TCP and UDP ranges for use
|
@@ -716,51 +726,57 @@ module Aws::GameLift
|
|
716
726
|
# or add more by updating the fleet.
|
717
727
|
#
|
718
728
|
# @option params [String] :new_game_session_protection_policy
|
719
|
-
#
|
729
|
+
# A game session protection policy to apply to all instances in this
|
720
730
|
# fleet. If this parameter is not set, instances in this fleet default
|
721
731
|
# to no protection. You can change a fleet's protection policy using
|
722
732
|
# UpdateFleetAttributes, but this change will only affect sessions
|
723
733
|
# created after the policy change. You can also set protection for
|
724
734
|
# individual instances using UpdateGameSession.
|
725
735
|
#
|
726
|
-
# * **NoProtection**
|
736
|
+
# * **NoProtection** - The game session can be terminated during a
|
727
737
|
# scale-down event.
|
728
738
|
#
|
729
|
-
# * **FullProtection**
|
739
|
+
# * **FullProtection** - If the game session is in an `ACTIVE` status,
|
730
740
|
# it cannot be terminated during a scale-down event.
|
731
741
|
#
|
732
742
|
# @option params [Types::RuntimeConfiguration] :runtime_configuration
|
733
743
|
# Instructions for launching server processes on each instance in the
|
734
744
|
# fleet. Server processes run either a custom game build executable or a
|
735
|
-
# Realtime
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
745
|
+
# Realtime script. The runtime configuration defines the server
|
746
|
+
# executables or launch script file, launch parameters, and the number
|
747
|
+
# of processes to run concurrently on each instance. When creating a
|
748
|
+
# fleet, the runtime configuration must have at least one server process
|
749
|
+
# configuration; otherwise the request fails with an invalid request
|
750
|
+
# exception. (This parameter replaces the parameters `ServerLaunchPath`
|
751
|
+
# and `ServerLaunchParameters`, although requests that contain values
|
752
|
+
# for these parameters instead of a runtime configuration will continue
|
753
|
+
# to work.) This parameter is required unless the parameters
|
754
|
+
# `ServerLaunchPath` and `ServerLaunchParameters` are defined. Runtime
|
755
|
+
# configuration replaced these parameters, but fleets that use them will
|
756
|
+
# continue to work.
|
741
757
|
#
|
742
758
|
# @option params [Types::ResourceCreationLimitPolicy] :resource_creation_limit_policy
|
743
|
-
#
|
759
|
+
# A policy that limits the number of game sessions an individual player
|
744
760
|
# can create over a span of time for this fleet.
|
745
761
|
#
|
746
762
|
# @option params [Array<String>] :metric_groups
|
747
|
-
#
|
763
|
+
# The name of an Amazon CloudWatch metric group to add this fleet to. A
|
748
764
|
# metric group aggregates the metrics for all fleets in the group.
|
749
765
|
# Specify an existing metric group name, or provide a new name to create
|
750
766
|
# a new metric group. A fleet can only be included in one metric group
|
751
767
|
# at a time.
|
752
768
|
#
|
753
769
|
# @option params [String] :peer_vpc_aws_account_id
|
754
|
-
#
|
755
|
-
# peer your Amazon GameLift fleet with. You can find your
|
770
|
+
# A unique identifier for the AWS account with the VPC that you want to
|
771
|
+
# peer your Amazon GameLift fleet with. You can find your account ID in
|
756
772
|
# the AWS Management Console under account settings.
|
757
773
|
#
|
758
774
|
# @option params [String] :peer_vpc_id
|
759
|
-
#
|
760
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
761
|
-
# fleet
|
762
|
-
#
|
763
|
-
#
|
775
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
776
|
+
# Amazon GameLift fleet. The VPC must be in the same Region as your
|
777
|
+
# fleet. To look up a VPC ID, use the [VPC Dashboard][1] in the AWS
|
778
|
+
# Management Console. Learn more about VPC peering in [VPC Peering with
|
779
|
+
# Amazon GameLift Fleets][2].
|
764
780
|
#
|
765
781
|
#
|
766
782
|
#
|
@@ -768,8 +784,8 @@ module Aws::GameLift
|
|
768
784
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html
|
769
785
|
#
|
770
786
|
# @option params [String] :fleet_type
|
771
|
-
# Indicates whether to use
|
772
|
-
# this fleet. If empty, the default is
|
787
|
+
# Indicates whether to use On-Demand instances or Spot instances for
|
788
|
+
# this fleet. If empty, the default is `ON_DEMAND`. Both categories of
|
773
789
|
# instances use identical hardware and configurations based on the
|
774
790
|
# instance type selected for this fleet. Learn more about [ On-Demand
|
775
791
|
# versus Spot Instances][1].
|
@@ -779,11 +795,11 @@ module Aws::GameLift
|
|
779
795
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot
|
780
796
|
#
|
781
797
|
# @option params [String] :instance_role_arn
|
782
|
-
#
|
783
|
-
# services. With an instance role ARN set, any application that runs
|
784
|
-
# an instance in this fleet can assume the role, including install
|
785
|
-
# scripts, server processes, daemons (background processes). Create
|
786
|
-
# role or look up a role's ARN
|
798
|
+
# A unique identifier for an AWS IAM role that manages access to your
|
799
|
+
# AWS services. With an instance role ARN set, any application that runs
|
800
|
+
# on an instance in this fleet can assume the role, including install
|
801
|
+
# scripts, server processes, and daemons (background processes). Create
|
802
|
+
# a role or look up a role's ARN from the [IAM dashboard][1] in the AWS
|
787
803
|
# Management Console. Learn more about using on-box credentials for your
|
788
804
|
# game servers at [ Access external resources from a game server][2].
|
789
805
|
#
|
@@ -793,6 +809,43 @@ module Aws::GameLift
|
|
793
809
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
794
810
|
#
|
795
811
|
# @option params [Types::CertificateConfiguration] :certificate_configuration
|
812
|
+
# Indicates whether to generate a TLS/SSL certificate for the new fleet.
|
813
|
+
# TLS certificates are used for encrypting traffic between game clients
|
814
|
+
# and game servers running on GameLift. If this parameter is not
|
815
|
+
# specified, the default value, DISABLED, is used. This fleet setting
|
816
|
+
# cannot be changed once the fleet is created. Learn more at [Securing
|
817
|
+
# Client/Server Communication][1].
|
818
|
+
#
|
819
|
+
# Note: This feature requires the AWS Certificate Manager (ACM) service,
|
820
|
+
# which is available in the AWS global partition but not in all other
|
821
|
+
# partitions. When working in a partition that does not support this
|
822
|
+
# feature, a request for a new fleet with certificate generation results
|
823
|
+
# fails with a 4xx unsupported Region error.
|
824
|
+
#
|
825
|
+
# Valid values include:
|
826
|
+
#
|
827
|
+
# * **GENERATED** - Generate a TLS/SSL certificate for this fleet.
|
828
|
+
#
|
829
|
+
# * **DISABLED** - (default) Do not generate a TLS/SSL certificate for
|
830
|
+
# this fleet.
|
831
|
+
#
|
832
|
+
#
|
833
|
+
#
|
834
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security
|
835
|
+
#
|
836
|
+
# @option params [Array<Types::Tag>] :tags
|
837
|
+
# A list of labels to assign to the new fleet resource. Tags are
|
838
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
839
|
+
# for resource management, access management and cost allocation. For
|
840
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
841
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
842
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
843
|
+
# The maximum tag limit may be lower than stated. See the AWS General
|
844
|
+
# Reference for actual tagging limits.
|
845
|
+
#
|
846
|
+
#
|
847
|
+
#
|
848
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
796
849
|
#
|
797
850
|
# @return [Types::CreateFleetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
798
851
|
#
|
@@ -841,6 +894,12 @@ module Aws::GameLift
|
|
841
894
|
# certificate_configuration: {
|
842
895
|
# certificate_type: "DISABLED", # required, accepts DISABLED, GENERATED
|
843
896
|
# },
|
897
|
+
# tags: [
|
898
|
+
# {
|
899
|
+
# key: "TagKey", # required
|
900
|
+
# value: "TagValue", # required
|
901
|
+
# },
|
902
|
+
# ],
|
844
903
|
# })
|
845
904
|
#
|
846
905
|
# @example Response structure
|
@@ -855,7 +914,9 @@ module Aws::GameLift
|
|
855
914
|
# resp.fleet_attributes.termination_time #=> Time
|
856
915
|
# resp.fleet_attributes.status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
857
916
|
# resp.fleet_attributes.build_id #=> String
|
917
|
+
# resp.fleet_attributes.build_arn #=> String
|
858
918
|
# resp.fleet_attributes.script_id #=> String
|
919
|
+
# resp.fleet_attributes.script_arn #=> String
|
859
920
|
# resp.fleet_attributes.server_launch_path #=> String
|
860
921
|
# resp.fleet_attributes.server_launch_parameters #=> String
|
861
922
|
# resp.fleet_attributes.log_paths #=> Array
|
@@ -935,20 +996,21 @@ module Aws::GameLift
|
|
935
996
|
# * StopGameSessionPlacement
|
936
997
|
#
|
937
998
|
# @option params [String] :fleet_id
|
938
|
-
#
|
939
|
-
#
|
999
|
+
# A unique identifier for a fleet to create a game session in. You can
|
1000
|
+
# use either the fleet ID or ARN value. Each request must reference
|
1001
|
+
# either a fleet ID or alias ID, but not both.
|
940
1002
|
#
|
941
1003
|
# @option params [String] :alias_id
|
942
|
-
#
|
943
|
-
# game session in.
|
944
|
-
# alias ID, but not both.
|
1004
|
+
# A unique identifier for an alias associated with the fleet to create a
|
1005
|
+
# game session in. You can use either the alias ID or ARN value. Each
|
1006
|
+
# request must reference either a fleet ID or alias ID, but not both.
|
945
1007
|
#
|
946
1008
|
# @option params [required, Integer] :maximum_player_session_count
|
947
|
-
#
|
948
|
-
# game session.
|
1009
|
+
# The maximum number of players that can be connected simultaneously to
|
1010
|
+
# the game session.
|
949
1011
|
#
|
950
1012
|
# @option params [String] :name
|
951
|
-
#
|
1013
|
+
# A descriptive label that is associated with a game session. Session
|
952
1014
|
# names do not need to be unique.
|
953
1015
|
#
|
954
1016
|
# @option params [Array<Types::GameProperty>] :game_properties
|
@@ -962,7 +1024,7 @@ module Aws::GameLift
|
|
962
1024
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
963
1025
|
#
|
964
1026
|
# @option params [String] :creator_id
|
965
|
-
#
|
1027
|
+
# A unique identifier for a player or entity creating the game session.
|
966
1028
|
# This ID is used to enforce a resource protection policy (if one
|
967
1029
|
# exists) that limits the number of concurrent active game sessions one
|
968
1030
|
# player can have.
|
@@ -1024,6 +1086,7 @@ module Aws::GameLift
|
|
1024
1086
|
# resp.game_session.game_session_id #=> String
|
1025
1087
|
# resp.game_session.name #=> String
|
1026
1088
|
# resp.game_session.fleet_id #=> String
|
1089
|
+
# resp.game_session.fleet_arn #=> String
|
1027
1090
|
# resp.game_session.creation_time #=> Time
|
1028
1091
|
# resp.game_session.termination_time #=> Time
|
1029
1092
|
# resp.game_session.current_player_session_count #=> Integer
|
@@ -1054,7 +1117,7 @@ module Aws::GameLift
|
|
1054
1117
|
# sessions. A queue identifies where new game sessions can be hosted --
|
1055
1118
|
# by specifying a list of destinations (fleets or aliases) -- and how
|
1056
1119
|
# long requests can wait in the queue before timing out. You can set up
|
1057
|
-
# a queue to try to place game sessions on fleets in multiple
|
1120
|
+
# a queue to try to place game sessions on fleets in multiple Regions.
|
1058
1121
|
# To add placement requests to a queue, call StartGameSessionPlacement
|
1059
1122
|
# and reference the queue name.
|
1060
1123
|
#
|
@@ -1094,33 +1157,47 @@ module Aws::GameLift
|
|
1094
1157
|
# * DeleteGameSessionQueue
|
1095
1158
|
#
|
1096
1159
|
# @option params [required, String] :name
|
1097
|
-
#
|
1098
|
-
# names must be unique within each
|
1160
|
+
# A descriptive label that is associated with game session queue. Queue
|
1161
|
+
# names must be unique within each Region.
|
1099
1162
|
#
|
1100
1163
|
# @option params [Integer] :timeout_in_seconds
|
1101
|
-
#
|
1102
|
-
# remains in the queue. When a request exceeds this time, the
|
1103
|
-
# session placement changes to a `TIMED_OUT` status.
|
1164
|
+
# The maximum time, in seconds, that a new game session placement
|
1165
|
+
# request remains in the queue. When a request exceeds this time, the
|
1166
|
+
# game session placement changes to a `TIMED_OUT` status.
|
1104
1167
|
#
|
1105
1168
|
# @option params [Array<Types::PlayerLatencyPolicy>] :player_latency_policies
|
1106
|
-
#
|
1107
|
-
# placement requests with player latency information. Multiple
|
1108
|
-
# are evaluated in order of the maximum latency value, starting
|
1109
|
-
# lowest latency values. With just one policy,
|
1110
|
-
# start of the game session placement for the duration
|
1111
|
-
# multiple policies, each policy is enforced consecutively
|
1112
|
-
# duration period. For example, a queue might enforce a
|
1113
|
-
# followed by a 120-second policy, and then no policy
|
1114
|
-
# of the placement. A player latency policy must set a
|
1115
|
-
# MaximumIndividualPlayerLatencyMilliseconds
|
1116
|
-
#
|
1169
|
+
# A collection of latency policies to apply when processing game
|
1170
|
+
# sessions placement requests with player latency information. Multiple
|
1171
|
+
# policies are evaluated in order of the maximum latency value, starting
|
1172
|
+
# with the lowest latency values. With just one policy, the policy is
|
1173
|
+
# enforced at the start of the game session placement for the duration
|
1174
|
+
# period. With multiple policies, each policy is enforced consecutively
|
1175
|
+
# for its duration period. For example, a queue might enforce a
|
1176
|
+
# 60-second policy followed by a 120-second policy, and then no policy
|
1177
|
+
# for the remainder of the placement. A player latency policy must set a
|
1178
|
+
# value for `MaximumIndividualPlayerLatencyMilliseconds`. If none is
|
1179
|
+
# set, this API request fails.
|
1117
1180
|
#
|
1118
1181
|
# @option params [Array<Types::GameSessionQueueDestination>] :destinations
|
1119
|
-
#
|
1182
|
+
# A list of fleets that can be used to fulfill game session placement
|
1120
1183
|
# requests in the queue. Fleets are identified by either a fleet ARN or
|
1121
1184
|
# a fleet alias ARN. Destinations are listed in default preference
|
1122
1185
|
# order.
|
1123
1186
|
#
|
1187
|
+
# @option params [Array<Types::Tag>] :tags
|
1188
|
+
# A list of labels to assign to the new game session queue resource.
|
1189
|
+
# Tags are developer-defined key-value pairs. Tagging AWS resources are
|
1190
|
+
# useful for resource management, access management and cost allocation.
|
1191
|
+
# For more information, see [ Tagging AWS Resources][1] in the *AWS
|
1192
|
+
# General Reference*. Once the resource is created, you can use
|
1193
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1194
|
+
# and view tags. The maximum tag limit may be lower than stated. See the
|
1195
|
+
# AWS General Reference for actual tagging limits.
|
1196
|
+
#
|
1197
|
+
#
|
1198
|
+
#
|
1199
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1200
|
+
#
|
1124
1201
|
# @return [Types::CreateGameSessionQueueOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1125
1202
|
#
|
1126
1203
|
# * {Types::CreateGameSessionQueueOutput#game_session_queue #game_session_queue} => Types::GameSessionQueue
|
@@ -1141,6 +1218,12 @@ module Aws::GameLift
|
|
1141
1218
|
# destination_arn: "ArnStringModel",
|
1142
1219
|
# },
|
1143
1220
|
# ],
|
1221
|
+
# tags: [
|
1222
|
+
# {
|
1223
|
+
# key: "TagKey", # required
|
1224
|
+
# value: "TagValue", # required
|
1225
|
+
# },
|
1226
|
+
# ],
|
1144
1227
|
# })
|
1145
1228
|
#
|
1146
1229
|
# @example Response structure
|
@@ -1216,60 +1299,61 @@ module Aws::GameLift
|
|
1216
1299
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
|
1217
1300
|
#
|
1218
1301
|
# @option params [required, String] :name
|
1219
|
-
#
|
1302
|
+
# A unique identifier for a matchmaking configuration. This name is used
|
1220
1303
|
# to identify the configuration associated with a matchmaking request or
|
1221
1304
|
# ticket.
|
1222
1305
|
#
|
1223
1306
|
# @option params [String] :description
|
1224
|
-
#
|
1307
|
+
# A human-readable description of the matchmaking configuration.
|
1225
1308
|
#
|
1226
1309
|
# @option params [required, Array<String>] :game_session_queue_arns
|
1227
|
-
# Amazon Resource Name ([ARN][1]) that is assigned to a game
|
1228
|
-
# queue and uniquely identifies it.
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
# located in any region.
|
1310
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
1311
|
+
# session queue resource and uniquely identifies it. ARNs are unique
|
1312
|
+
# across all Regions. These queues are used when placing game sessions
|
1313
|
+
# for matches that are created with this matchmaking configuration.
|
1314
|
+
# Queues can be located in any Region.
|
1233
1315
|
#
|
1234
1316
|
#
|
1235
1317
|
#
|
1236
|
-
# [1]: https://docs.aws.amazon.com/
|
1318
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1237
1319
|
#
|
1238
1320
|
# @option params [required, Integer] :request_timeout_seconds
|
1239
|
-
#
|
1240
|
-
# process before timing out. Requests that fail due to timing out can
|
1241
|
-
# resubmitted as needed.
|
1321
|
+
# The maximum duration, in seconds, that a matchmaking ticket can remain
|
1322
|
+
# in process before timing out. Requests that fail due to timing out can
|
1323
|
+
# be resubmitted as needed.
|
1242
1324
|
#
|
1243
1325
|
# @option params [Integer] :acceptance_timeout_seconds
|
1244
|
-
#
|
1245
|
-
# match. If any player rejects the match or fails to accept
|
1246
|
-
# timeout, the ticket continues to look for an acceptable
|
1326
|
+
# The length of time (in seconds) to wait for players to accept a
|
1327
|
+
# proposed match. If any player rejects the match or fails to accept
|
1328
|
+
# before the timeout, the ticket continues to look for an acceptable
|
1329
|
+
# match.
|
1247
1330
|
#
|
1248
1331
|
# @option params [required, Boolean] :acceptance_required
|
1249
|
-
#
|
1332
|
+
# A flag that determines whether a match that was created with this
|
1250
1333
|
# configuration must be accepted by the matched players. To require
|
1251
|
-
# acceptance, set to TRUE
|
1334
|
+
# acceptance, set to `TRUE`.
|
1252
1335
|
#
|
1253
1336
|
# @option params [required, String] :rule_set_name
|
1254
|
-
#
|
1255
|
-
# configuration.
|
1256
|
-
# are defined in
|
1337
|
+
# A unique identifier for a matchmaking rule set to use with this
|
1338
|
+
# configuration. You can use either the rule set name or ARN value. A
|
1339
|
+
# matchmaking configuration can only use rule sets that are defined in
|
1340
|
+
# the same Region.
|
1257
1341
|
#
|
1258
1342
|
# @option params [String] :notification_target
|
1259
|
-
# SNS topic ARN that is set up to receive matchmaking notifications.
|
1343
|
+
# An SNS topic ARN that is set up to receive matchmaking notifications.
|
1260
1344
|
#
|
1261
1345
|
# @option params [Integer] :additional_player_count
|
1262
|
-
#
|
1263
|
-
# example,
|
1264
|
-
# single 12-person team
|
1265
|
-
# only 10 players are selected for the match.
|
1346
|
+
# The number of player slots in a match to keep open for future players.
|
1347
|
+
# For example, assume that the configuration's rule set specifies a
|
1348
|
+
# match for a single 12-person team. If the additional player count is
|
1349
|
+
# set to 2, only 10 players are initially selected for the match.
|
1266
1350
|
#
|
1267
1351
|
# @option params [String] :custom_event_data
|
1268
1352
|
# Information to be added to all events related to this matchmaking
|
1269
1353
|
# configuration.
|
1270
1354
|
#
|
1271
1355
|
# @option params [Array<Types::GameProperty>] :game_properties
|
1272
|
-
#
|
1356
|
+
# A set of custom properties for a game session, formatted as key-value
|
1273
1357
|
# pairs. These properties are passed to a game server process in the
|
1274
1358
|
# GameSession object with a request to start a new game session (see
|
1275
1359
|
# [Start a Game Session][1]). This information is added to the new
|
@@ -1280,7 +1364,7 @@ module Aws::GameLift
|
|
1280
1364
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1281
1365
|
#
|
1282
1366
|
# @option params [String] :game_session_data
|
1283
|
-
#
|
1367
|
+
# A set of custom game session properties, formatted as a single string
|
1284
1368
|
# value. This data is passed to a game server process in the GameSession
|
1285
1369
|
# object with a request to start a new game session (see [Start a Game
|
1286
1370
|
# Session][1]). This information is added to the new GameSession object
|
@@ -1291,17 +1375,32 @@ module Aws::GameLift
|
|
1291
1375
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1292
1376
|
#
|
1293
1377
|
# @option params [String] :backfill_mode
|
1294
|
-
#
|
1295
|
-
# configuration. Specify MANUAL when your game manages
|
1296
|
-
# manually or does not use the match backfill feature.
|
1297
|
-
# to have GameLift create a StartMatchBackfill
|
1298
|
-
# session has one or more open slots. Learn more
|
1299
|
-
# automatic backfill in [ Backfill Existing Games with
|
1378
|
+
# The method used to backfill game sessions that are created with this
|
1379
|
+
# matchmaking configuration. Specify `MANUAL` when your game manages
|
1380
|
+
# backfill requests manually or does not use the match backfill feature.
|
1381
|
+
# Specify `AUTOMATIC` to have GameLift create a StartMatchBackfill
|
1382
|
+
# request whenever a game session has one or more open slots. Learn more
|
1383
|
+
# about manual and automatic backfill in [ Backfill Existing Games with
|
1384
|
+
# FlexMatch][1].
|
1300
1385
|
#
|
1301
1386
|
#
|
1302
1387
|
#
|
1303
1388
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html
|
1304
1389
|
#
|
1390
|
+
# @option params [Array<Types::Tag>] :tags
|
1391
|
+
# A list of labels to assign to the new matchmaking configuration
|
1392
|
+
# resource. Tags are developer-defined key-value pairs. Tagging AWS
|
1393
|
+
# resources are useful for resource management, access management and
|
1394
|
+
# cost allocation. For more information, see [ Tagging AWS Resources][1]
|
1395
|
+
# in the *AWS General Reference*. Once the resource is created, you can
|
1396
|
+
# use TagResource, UntagResource, and ListTagsForResource to add,
|
1397
|
+
# remove, and view tags. The maximum tag limit may be lower than stated.
|
1398
|
+
# See the AWS General Reference for actual tagging limits.
|
1399
|
+
#
|
1400
|
+
#
|
1401
|
+
#
|
1402
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1403
|
+
#
|
1305
1404
|
# @return [Types::CreateMatchmakingConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1306
1405
|
#
|
1307
1406
|
# * {Types::CreateMatchmakingConfigurationOutput#configuration #configuration} => Types::MatchmakingConfiguration
|
@@ -1315,7 +1414,7 @@ module Aws::GameLift
|
|
1315
1414
|
# request_timeout_seconds: 1, # required
|
1316
1415
|
# acceptance_timeout_seconds: 1,
|
1317
1416
|
# acceptance_required: false, # required
|
1318
|
-
# rule_set_name: "
|
1417
|
+
# rule_set_name: "MatchmakingRuleSetName", # required
|
1319
1418
|
# notification_target: "SnsArnStringModel",
|
1320
1419
|
# additional_player_count: 1,
|
1321
1420
|
# custom_event_data: "CustomEventData",
|
@@ -1327,11 +1426,18 @@ module Aws::GameLift
|
|
1327
1426
|
# ],
|
1328
1427
|
# game_session_data: "GameSessionData",
|
1329
1428
|
# backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
|
1429
|
+
# tags: [
|
1430
|
+
# {
|
1431
|
+
# key: "TagKey", # required
|
1432
|
+
# value: "TagValue", # required
|
1433
|
+
# },
|
1434
|
+
# ],
|
1330
1435
|
# })
|
1331
1436
|
#
|
1332
1437
|
# @example Response structure
|
1333
1438
|
#
|
1334
1439
|
# resp.configuration.name #=> String
|
1440
|
+
# resp.configuration.configuration_arn #=> String
|
1335
1441
|
# resp.configuration.description #=> String
|
1336
1442
|
# resp.configuration.game_session_queue_arns #=> Array
|
1337
1443
|
# resp.configuration.game_session_queue_arns[0] #=> String
|
@@ -1339,6 +1445,7 @@ module Aws::GameLift
|
|
1339
1445
|
# resp.configuration.acceptance_timeout_seconds #=> Integer
|
1340
1446
|
# resp.configuration.acceptance_required #=> Boolean
|
1341
1447
|
# resp.configuration.rule_set_name #=> String
|
1448
|
+
# resp.configuration.rule_set_arn #=> String
|
1342
1449
|
# resp.configuration.notification_target #=> String
|
1343
1450
|
# resp.configuration.additional_player_count #=> Integer
|
1344
1451
|
# resp.configuration.custom_event_data #=> String
|
@@ -1359,14 +1466,14 @@ module Aws::GameLift
|
|
1359
1466
|
end
|
1360
1467
|
|
1361
1468
|
# Creates a new rule set for FlexMatch matchmaking. A rule set describes
|
1362
|
-
# the type of match to create, such as the number and size of teams
|
1363
|
-
# sets the parameters for acceptable player matches, such as
|
1364
|
-
# skill level or character type. A rule set is used by a
|
1469
|
+
# the type of match to create, such as the number and size of teams. It
|
1470
|
+
# also sets the parameters for acceptable player matches, such as
|
1471
|
+
# minimum skill level or character type. A rule set is used by a
|
1365
1472
|
# MatchmakingConfiguration.
|
1366
1473
|
#
|
1367
1474
|
# To create a matchmaking rule set, provide unique rule set name and the
|
1368
1475
|
# rule set body in JSON format. Rule sets must be defined in the same
|
1369
|
-
#
|
1476
|
+
# Region as the matchmaking configuration they are used with.
|
1370
1477
|
#
|
1371
1478
|
# Since matchmaking rule sets cannot be edited, it is a good idea to
|
1372
1479
|
# check the rule set syntax using ValidateMatchmakingRuleSet before
|
@@ -1405,15 +1512,29 @@ module Aws::GameLift
|
|
1405
1512
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-intro.html
|
1406
1513
|
#
|
1407
1514
|
# @option params [required, String] :name
|
1408
|
-
#
|
1409
|
-
# configuration identifies the rule set it uses by this name value.
|
1410
|
-
#
|
1411
|
-
#
|
1515
|
+
# A unique identifier for a matchmaking rule set. A matchmaking
|
1516
|
+
# configuration identifies the rule set it uses by this name value. Note
|
1517
|
+
# that the rule set name is different from the optional `name` field in
|
1518
|
+
# the rule set body.
|
1412
1519
|
#
|
1413
1520
|
# @option params [required, String] :rule_set_body
|
1414
|
-
#
|
1415
|
-
# are not allowed in JSON, but most elements support a
|
1416
|
-
# field.
|
1521
|
+
# A collection of matchmaking rules, formatted as a JSON string.
|
1522
|
+
# Comments are not allowed in JSON, but most elements support a
|
1523
|
+
# description field.
|
1524
|
+
#
|
1525
|
+
# @option params [Array<Types::Tag>] :tags
|
1526
|
+
# A list of labels to assign to the new matchmaking rule set resource.
|
1527
|
+
# Tags are developer-defined key-value pairs. Tagging AWS resources are
|
1528
|
+
# useful for resource management, access management and cost allocation.
|
1529
|
+
# For more information, see [ Tagging AWS Resources][1] in the *AWS
|
1530
|
+
# General Reference*. Once the resource is created, you can use
|
1531
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1532
|
+
# and view tags. The maximum tag limit may be lower than stated. See the
|
1533
|
+
# AWS General Reference for actual tagging limits.
|
1534
|
+
#
|
1535
|
+
#
|
1536
|
+
#
|
1537
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1417
1538
|
#
|
1418
1539
|
# @return [Types::CreateMatchmakingRuleSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1419
1540
|
#
|
@@ -1424,11 +1545,18 @@ module Aws::GameLift
|
|
1424
1545
|
# resp = client.create_matchmaking_rule_set({
|
1425
1546
|
# name: "MatchmakingIdStringModel", # required
|
1426
1547
|
# rule_set_body: "RuleSetBody", # required
|
1548
|
+
# tags: [
|
1549
|
+
# {
|
1550
|
+
# key: "TagKey", # required
|
1551
|
+
# value: "TagValue", # required
|
1552
|
+
# },
|
1553
|
+
# ],
|
1427
1554
|
# })
|
1428
1555
|
#
|
1429
1556
|
# @example Response structure
|
1430
1557
|
#
|
1431
1558
|
# resp.rule_set.rule_set_name #=> String
|
1559
|
+
# resp.rule_set.rule_set_arn #=> String
|
1432
1560
|
# resp.rule_set.rule_set_body #=> String
|
1433
1561
|
# resp.rule_set.creation_time #=> Time
|
1434
1562
|
#
|
@@ -1471,10 +1599,10 @@ module Aws::GameLift
|
|
1471
1599
|
# * StopGameSessionPlacement
|
1472
1600
|
#
|
1473
1601
|
# @option params [required, String] :game_session_id
|
1474
|
-
#
|
1602
|
+
# A unique identifier for the game session to add a player to.
|
1475
1603
|
#
|
1476
1604
|
# @option params [required, String] :player_id
|
1477
|
-
#
|
1605
|
+
# A unique identifier for a player. Player IDs are developer-defined.
|
1478
1606
|
#
|
1479
1607
|
# @option params [String] :player_data
|
1480
1608
|
# Developer-defined information related to a player. Amazon GameLift
|
@@ -1499,6 +1627,7 @@ module Aws::GameLift
|
|
1499
1627
|
# resp.player_session.player_id #=> String
|
1500
1628
|
# resp.player_session.game_session_id #=> String
|
1501
1629
|
# resp.player_session.fleet_id #=> String
|
1630
|
+
# resp.player_session.fleet_arn #=> String
|
1502
1631
|
# resp.player_session.creation_time #=> Time
|
1503
1632
|
# resp.player_session.termination_time #=> Time
|
1504
1633
|
# resp.player_session.status #=> String, one of "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT"
|
@@ -1546,7 +1675,7 @@ module Aws::GameLift
|
|
1546
1675
|
# * StopGameSessionPlacement
|
1547
1676
|
#
|
1548
1677
|
# @option params [required, String] :game_session_id
|
1549
|
-
#
|
1678
|
+
# A unique identifier for the game session to add players to.
|
1550
1679
|
#
|
1551
1680
|
# @option params [required, Array<String>] :player_ids
|
1552
1681
|
# List of unique identifiers for the players to be added.
|
@@ -1579,6 +1708,7 @@ module Aws::GameLift
|
|
1579
1708
|
# resp.player_sessions[0].player_id #=> String
|
1580
1709
|
# resp.player_sessions[0].game_session_id #=> String
|
1581
1710
|
# resp.player_sessions[0].fleet_id #=> String
|
1711
|
+
# resp.player_sessions[0].fleet_arn #=> String
|
1582
1712
|
# resp.player_sessions[0].creation_time #=> Time
|
1583
1713
|
# resp.player_sessions[0].termination_time #=> Time
|
1584
1714
|
# resp.player_sessions[0].status #=> String, one of "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT"
|
@@ -1646,35 +1776,49 @@ module Aws::GameLift
|
|
1646
1776
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html
|
1647
1777
|
#
|
1648
1778
|
# @option params [String] :name
|
1649
|
-
#
|
1779
|
+
# A descriptive label that is associated with a script. Script names do
|
1650
1780
|
# not need to be unique. You can use UpdateScript to change this value
|
1651
1781
|
# later.
|
1652
1782
|
#
|
1653
1783
|
# @option params [String] :version
|
1654
|
-
#
|
1655
|
-
# not need to be unique. You can use UpdateScript to change this
|
1656
|
-
# later.
|
1784
|
+
# The version that is associated with a build or script. Version strings
|
1785
|
+
# do not need to be unique. You can use UpdateScript to change this
|
1786
|
+
# value later.
|
1657
1787
|
#
|
1658
1788
|
# @option params [Types::S3Location] :storage_location
|
1659
|
-
#
|
1660
|
-
# Realtime scripts is stored. The storage location must specify the
|
1789
|
+
# The location of the Amazon S3 bucket where a zipped file containing
|
1790
|
+
# your Realtime scripts is stored. The storage location must specify the
|
1661
1791
|
# Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
|
1662
1792
|
# that allows Amazon GameLift to access the Amazon S3 storage location.
|
1663
|
-
# The S3 bucket must be in the same
|
1793
|
+
# The S3 bucket must be in the same Region where you want to create a
|
1664
1794
|
# new script. By default, Amazon GameLift uploads the latest version of
|
1665
1795
|
# the zip file; if you have S3 object versioning turned on, you can use
|
1666
1796
|
# the `ObjectVersion` parameter to specify an earlier version.
|
1667
1797
|
#
|
1668
1798
|
# @option params [String, IO] :zip_file
|
1669
|
-
#
|
1670
|
-
# file. The zip file can have one or multiple files. Maximum size of
|
1671
|
-
# zip file is 5 MB.
|
1799
|
+
# A data object containing your Realtime scripts and dependencies as a
|
1800
|
+
# zip file. The zip file can have one or multiple files. Maximum size of
|
1801
|
+
# a zip file is 5 MB.
|
1672
1802
|
#
|
1673
1803
|
# When using the AWS CLI tool to create a script, this parameter is set
|
1674
1804
|
# to the zip file name. It must be prepended with the string
|
1675
1805
|
# "fileb://" to indicate that the file data is a binary object. For
|
1676
1806
|
# example: `--zip-file fileb://myRealtimeScript.zip`.
|
1677
1807
|
#
|
1808
|
+
# @option params [Array<Types::Tag>] :tags
|
1809
|
+
# A list of labels to assign to the new script resource. Tags are
|
1810
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
1811
|
+
# for resource management, access management and cost allocation. For
|
1812
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
1813
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
1814
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
1815
|
+
# The maximum tag limit may be lower than stated. See the AWS General
|
1816
|
+
# Reference for actual tagging limits.
|
1817
|
+
#
|
1818
|
+
#
|
1819
|
+
#
|
1820
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1821
|
+
#
|
1678
1822
|
# @return [Types::CreateScriptOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1679
1823
|
#
|
1680
1824
|
# * {Types::CreateScriptOutput#script #script} => Types::Script
|
@@ -1691,11 +1835,18 @@ module Aws::GameLift
|
|
1691
1835
|
# object_version: "NonEmptyString",
|
1692
1836
|
# },
|
1693
1837
|
# zip_file: "data",
|
1838
|
+
# tags: [
|
1839
|
+
# {
|
1840
|
+
# key: "TagKey", # required
|
1841
|
+
# value: "TagValue", # required
|
1842
|
+
# },
|
1843
|
+
# ],
|
1694
1844
|
# })
|
1695
1845
|
#
|
1696
1846
|
# @example Response structure
|
1697
1847
|
#
|
1698
1848
|
# resp.script.script_id #=> String
|
1849
|
+
# resp.script.script_arn #=> String
|
1699
1850
|
# resp.script.name #=> String
|
1700
1851
|
# resp.script.version #=> String
|
1701
1852
|
# resp.script.size_on_disk #=> Integer
|
@@ -1725,7 +1876,7 @@ module Aws::GameLift
|
|
1725
1876
|
# You can peer with VPCs that are owned by any AWS account you have
|
1726
1877
|
# access to, including the account that you use to manage your Amazon
|
1727
1878
|
# GameLift fleets. You cannot peer with VPCs that are in different
|
1728
|
-
#
|
1879
|
+
# Regions.
|
1729
1880
|
#
|
1730
1881
|
# To request authorization to create a connection, call this operation
|
1731
1882
|
# from the AWS account with the VPC that you want to peer to your Amazon
|
@@ -1763,13 +1914,13 @@ module Aws::GameLift
|
|
1763
1914
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html
|
1764
1915
|
#
|
1765
1916
|
# @option params [required, String] :game_lift_aws_account_id
|
1766
|
-
#
|
1917
|
+
# A unique identifier for the AWS account that you use to manage your
|
1767
1918
|
# Amazon GameLift fleet. You can find your Account ID in the AWS
|
1768
1919
|
# Management Console under account settings.
|
1769
1920
|
#
|
1770
1921
|
# @option params [required, String] :peer_vpc_id
|
1771
|
-
#
|
1772
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
1922
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
1923
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
1773
1924
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
1774
1925
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
1775
1926
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -1813,7 +1964,7 @@ module Aws::GameLift
|
|
1813
1964
|
# directly with other AWS resources. You can peer with VPCs in any AWS
|
1814
1965
|
# account that you have access to, including the account that you use to
|
1815
1966
|
# manage your Amazon GameLift fleets. You cannot peer with VPCs that are
|
1816
|
-
# in different
|
1967
|
+
# in different Regions. For more information, see [VPC Peering with
|
1817
1968
|
# Amazon GameLift Fleets][1].
|
1818
1969
|
#
|
1819
1970
|
# Before calling this operation to establish the peering connection, you
|
@@ -1851,17 +2002,17 @@ module Aws::GameLift
|
|
1851
2002
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html
|
1852
2003
|
#
|
1853
2004
|
# @option params [required, String] :fleet_id
|
1854
|
-
#
|
1855
|
-
# GameLift VPC to peer with.
|
2005
|
+
# A unique identifier for a fleet. You can use either the fleet ID or
|
2006
|
+
# ARN value. This tells Amazon GameLift which GameLift VPC to peer with.
|
1856
2007
|
#
|
1857
2008
|
# @option params [required, String] :peer_vpc_aws_account_id
|
1858
|
-
#
|
2009
|
+
# A unique identifier for the AWS account with the VPC that you want to
|
1859
2010
|
# peer your Amazon GameLift fleet with. You can find your Account ID in
|
1860
2011
|
# the AWS Management Console under account settings.
|
1861
2012
|
#
|
1862
2013
|
# @option params [required, String] :peer_vpc_id
|
1863
|
-
#
|
1864
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
2014
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
2015
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
1865
2016
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
1866
2017
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
1867
2018
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -1908,8 +2059,8 @@ module Aws::GameLift
|
|
1908
2059
|
# * ResolveAlias
|
1909
2060
|
#
|
1910
2061
|
# @option params [required, String] :alias_id
|
1911
|
-
#
|
1912
|
-
#
|
2062
|
+
# A unique identifier of the alias that you want to delete. You can use
|
2063
|
+
# either the alias ID or ARN value.
|
1913
2064
|
#
|
1914
2065
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1915
2066
|
#
|
@@ -1956,7 +2107,8 @@ module Aws::GameLift
|
|
1956
2107
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
1957
2108
|
#
|
1958
2109
|
# @option params [required, String] :build_id
|
1959
|
-
#
|
2110
|
+
# A unique identifier for a build to delete. You can use either the
|
2111
|
+
# build ID or ARN value.
|
1960
2112
|
#
|
1961
2113
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1962
2114
|
#
|
@@ -2000,31 +2152,9 @@ module Aws::GameLift
|
|
2000
2152
|
#
|
2001
2153
|
# * DeleteFleet
|
2002
2154
|
#
|
2003
|
-
# *
|
2004
|
-
#
|
2005
|
-
# * DescribeFleetAttributes
|
2006
|
-
#
|
2007
|
-
# * DescribeFleetCapacity
|
2008
|
-
#
|
2009
|
-
# * DescribeFleetPortSettings
|
2010
|
-
#
|
2011
|
-
# * DescribeFleetUtilization
|
2012
|
-
#
|
2013
|
-
# * DescribeRuntimeConfiguration
|
2014
|
-
#
|
2015
|
-
# * DescribeEC2InstanceLimits
|
2016
|
-
#
|
2017
|
-
# * DescribeFleetEvents
|
2018
|
-
#
|
2019
|
-
# * Update fleets:
|
2020
|
-
#
|
2021
|
-
# * UpdateFleetAttributes
|
2022
|
-
#
|
2023
|
-
# * UpdateFleetCapacity
|
2024
|
-
#
|
2025
|
-
# * UpdateFleetPortSettings
|
2155
|
+
# * DescribeFleetAttributes
|
2026
2156
|
#
|
2027
|
-
#
|
2157
|
+
# * UpdateFleetAttributes
|
2028
2158
|
#
|
2029
2159
|
# * Manage fleet actions:
|
2030
2160
|
#
|
@@ -2037,7 +2167,8 @@ module Aws::GameLift
|
|
2037
2167
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2038
2168
|
#
|
2039
2169
|
# @option params [required, String] :fleet_id
|
2040
|
-
#
|
2170
|
+
# A unique identifier for a fleet to be deleted. You can use either the
|
2171
|
+
# fleet ID or ARN value.
|
2041
2172
|
#
|
2042
2173
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2043
2174
|
#
|
@@ -2069,8 +2200,9 @@ module Aws::GameLift
|
|
2069
2200
|
# * DeleteGameSessionQueue
|
2070
2201
|
#
|
2071
2202
|
# @option params [required, String] :name
|
2072
|
-
#
|
2073
|
-
# names must be unique within each
|
2203
|
+
# A descriptive label that is associated with game session queue. Queue
|
2204
|
+
# names must be unique within each Region. You can use either the queue
|
2205
|
+
# ID or ARN value.
|
2074
2206
|
#
|
2075
2207
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2076
2208
|
#
|
@@ -2112,14 +2244,15 @@ module Aws::GameLift
|
|
2112
2244
|
# * DeleteMatchmakingRuleSet
|
2113
2245
|
#
|
2114
2246
|
# @option params [required, String] :name
|
2115
|
-
#
|
2247
|
+
# A unique identifier for a matchmaking configuration. You can use
|
2248
|
+
# either the configuration name or ARN value.
|
2116
2249
|
#
|
2117
2250
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2118
2251
|
#
|
2119
2252
|
# @example Request syntax with placeholder values
|
2120
2253
|
#
|
2121
2254
|
# resp = client.delete_matchmaking_configuration({
|
2122
|
-
# name: "
|
2255
|
+
# name: "MatchmakingConfigurationName", # required
|
2123
2256
|
# })
|
2124
2257
|
#
|
2125
2258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingConfiguration AWS API Documentation
|
@@ -2164,16 +2297,16 @@ module Aws::GameLift
|
|
2164
2297
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
|
2165
2298
|
#
|
2166
2299
|
# @option params [required, String] :name
|
2167
|
-
#
|
2168
|
-
# rule set name is different from the optional "name" field in the
|
2169
|
-
# rule set body.)
|
2300
|
+
# A unique identifier for a matchmaking rule set to be deleted. (Note:
|
2301
|
+
# The rule set name is different from the optional "name" field in the
|
2302
|
+
# rule set body.) You can use either the rule set name or ARN value.
|
2170
2303
|
#
|
2171
2304
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2172
2305
|
#
|
2173
2306
|
# @example Request syntax with placeholder values
|
2174
2307
|
#
|
2175
2308
|
# resp = client.delete_matchmaking_rule_set({
|
2176
|
-
# name: "
|
2309
|
+
# name: "MatchmakingRuleSetName", # required
|
2177
2310
|
# })
|
2178
2311
|
#
|
2179
2312
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingRuleSet AWS API Documentation
|
@@ -2214,11 +2347,12 @@ module Aws::GameLift
|
|
2214
2347
|
# * StopFleetActions
|
2215
2348
|
#
|
2216
2349
|
# @option params [required, String] :name
|
2217
|
-
#
|
2350
|
+
# A descriptive label that is associated with a scaling policy. Policy
|
2218
2351
|
# names do not need to be unique.
|
2219
2352
|
#
|
2220
2353
|
# @option params [required, String] :fleet_id
|
2221
|
-
#
|
2354
|
+
# A unique identifier for a fleet to be deleted. You can use either the
|
2355
|
+
# fleet ID or ARN value.
|
2222
2356
|
#
|
2223
2357
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2224
2358
|
#
|
@@ -2269,7 +2403,8 @@ module Aws::GameLift
|
|
2269
2403
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html
|
2270
2404
|
#
|
2271
2405
|
# @option params [required, String] :script_id
|
2272
|
-
#
|
2406
|
+
# A unique identifier for a Realtime script to delete. You can use
|
2407
|
+
# either the script ID or ARN value.
|
2273
2408
|
#
|
2274
2409
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2275
2410
|
#
|
@@ -2305,13 +2440,13 @@ module Aws::GameLift
|
|
2305
2440
|
# * DeleteVpcPeeringConnection
|
2306
2441
|
#
|
2307
2442
|
# @option params [required, String] :game_lift_aws_account_id
|
2308
|
-
#
|
2443
|
+
# A unique identifier for the AWS account that you use to manage your
|
2309
2444
|
# Amazon GameLift fleet. You can find your Account ID in the AWS
|
2310
2445
|
# Management Console under account settings.
|
2311
2446
|
#
|
2312
2447
|
# @option params [required, String] :peer_vpc_id
|
2313
|
-
#
|
2314
|
-
# Amazon GameLift fleet. The VPC must be in the same
|
2448
|
+
# A unique identifier for a VPC with resources to be accessed by your
|
2449
|
+
# Amazon GameLift fleet. The VPC must be in the same Region where your
|
2315
2450
|
# fleet is deployed. Look up a VPC ID using the [VPC Dashboard][1] in
|
2316
2451
|
# the AWS Management Console. Learn more about VPC peering in [VPC
|
2317
2452
|
# Peering with Amazon GameLift Fleets][2].
|
@@ -2363,13 +2498,14 @@ module Aws::GameLift
|
|
2363
2498
|
# * DeleteVpcPeeringConnection
|
2364
2499
|
#
|
2365
2500
|
# @option params [required, String] :fleet_id
|
2366
|
-
#
|
2367
|
-
# referenced in the VPC peering connection record.
|
2501
|
+
# A unique identifier for a fleet. This fleet specified must match the
|
2502
|
+
# fleet referenced in the VPC peering connection record. You can use
|
2503
|
+
# either the fleet ID or ARN value.
|
2368
2504
|
#
|
2369
2505
|
# @option params [required, String] :vpc_peering_connection_id
|
2370
|
-
#
|
2371
|
-
# in the VpcPeeringConnection object, which can be retrieved by
|
2372
|
-
# DescribeVpcPeeringConnections.
|
2506
|
+
# A unique identifier for a VPC peering connection. This value is
|
2507
|
+
# included in the VpcPeeringConnection object, which can be retrieved by
|
2508
|
+
# calling DescribeVpcPeeringConnections.
|
2373
2509
|
#
|
2374
2510
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2375
2511
|
#
|
@@ -2409,8 +2545,8 @@ module Aws::GameLift
|
|
2409
2545
|
# * ResolveAlias
|
2410
2546
|
#
|
2411
2547
|
# @option params [required, String] :alias_id
|
2412
|
-
#
|
2413
|
-
#
|
2548
|
+
# The unique identifier for the fleet alias that you want to retrieve.
|
2549
|
+
# You can use either the alias ID or ARN value.
|
2414
2550
|
#
|
2415
2551
|
# @return [Types::DescribeAliasOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2416
2552
|
#
|
@@ -2468,7 +2604,8 @@ module Aws::GameLift
|
|
2468
2604
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
2469
2605
|
#
|
2470
2606
|
# @option params [required, String] :build_id
|
2471
|
-
#
|
2607
|
+
# A unique identifier for a build to retrieve properties for. You can
|
2608
|
+
# use either the build ID or ARN value.
|
2472
2609
|
#
|
2473
2610
|
# @return [Types::DescribeBuildOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2474
2611
|
#
|
@@ -2483,6 +2620,7 @@ module Aws::GameLift
|
|
2483
2620
|
# @example Response structure
|
2484
2621
|
#
|
2485
2622
|
# resp.build.build_id #=> String
|
2623
|
+
# resp.build.build_arn #=> String
|
2486
2624
|
# resp.build.name #=> String
|
2487
2625
|
# resp.build.version #=> String
|
2488
2626
|
# resp.build.status #=> String, one of "INITIALIZED", "READY", "FAILED"
|
@@ -2506,7 +2644,7 @@ module Aws::GameLift
|
|
2506
2644
|
#
|
2507
2645
|
# * current usage level for the AWS account
|
2508
2646
|
#
|
2509
|
-
# Service limits vary depending on
|
2647
|
+
# Service limits vary depending on Region. Available Regions for Amazon
|
2510
2648
|
# GameLift can be found in the AWS Management Console for Amazon
|
2511
2649
|
# GameLift (see the drop-down list in the upper right corner).
|
2512
2650
|
#
|
@@ -2639,15 +2777,7 @@ module Aws::GameLift
|
|
2639
2777
|
#
|
2640
2778
|
# * DescribeFleetEvents
|
2641
2779
|
#
|
2642
|
-
# *
|
2643
|
-
#
|
2644
|
-
# * UpdateFleetAttributes
|
2645
|
-
#
|
2646
|
-
# * UpdateFleetCapacity
|
2647
|
-
#
|
2648
|
-
# * UpdateFleetPortSettings
|
2649
|
-
#
|
2650
|
-
# * UpdateRuntimeConfiguration
|
2780
|
+
# * UpdateFleetAttributes
|
2651
2781
|
#
|
2652
2782
|
# * Manage fleet actions:
|
2653
2783
|
#
|
@@ -2660,11 +2790,11 @@ module Aws::GameLift
|
|
2660
2790
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2661
2791
|
#
|
2662
2792
|
# @option params [Array<String>] :fleet_ids
|
2663
|
-
#
|
2664
|
-
#
|
2793
|
+
# A unique identifier for a fleet(s) to retrieve attributes for. You can
|
2794
|
+
# use either the fleet ID or ARN value.
|
2665
2795
|
#
|
2666
2796
|
# @option params [Integer] :limit
|
2667
|
-
#
|
2797
|
+
# The maximum number of results to return. Use this parameter with
|
2668
2798
|
# `NextToken` to get results as a set of sequential pages. This
|
2669
2799
|
# parameter is ignored when the request specifies one or a list of fleet
|
2670
2800
|
# IDs.
|
@@ -2702,7 +2832,9 @@ module Aws::GameLift
|
|
2702
2832
|
# resp.fleet_attributes[0].termination_time #=> Time
|
2703
2833
|
# resp.fleet_attributes[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
2704
2834
|
# resp.fleet_attributes[0].build_id #=> String
|
2835
|
+
# resp.fleet_attributes[0].build_arn #=> String
|
2705
2836
|
# resp.fleet_attributes[0].script_id #=> String
|
2837
|
+
# resp.fleet_attributes[0].script_arn #=> String
|
2706
2838
|
# resp.fleet_attributes[0].server_launch_path #=> String
|
2707
2839
|
# resp.fleet_attributes[0].server_launch_parameters #=> String
|
2708
2840
|
# resp.fleet_attributes[0].log_paths #=> Array
|
@@ -2772,15 +2904,7 @@ module Aws::GameLift
|
|
2772
2904
|
#
|
2773
2905
|
# * DescribeFleetEvents
|
2774
2906
|
#
|
2775
|
-
# *
|
2776
|
-
#
|
2777
|
-
# * UpdateFleetAttributes
|
2778
|
-
#
|
2779
|
-
# * UpdateFleetCapacity
|
2780
|
-
#
|
2781
|
-
# * UpdateFleetPortSettings
|
2782
|
-
#
|
2783
|
-
# * UpdateRuntimeConfiguration
|
2907
|
+
# * UpdateFleetAttributes
|
2784
2908
|
#
|
2785
2909
|
# * Manage fleet actions:
|
2786
2910
|
#
|
@@ -2793,12 +2917,11 @@ module Aws::GameLift
|
|
2793
2917
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2794
2918
|
#
|
2795
2919
|
# @option params [Array<String>] :fleet_ids
|
2796
|
-
#
|
2797
|
-
#
|
2798
|
-
# empty.
|
2920
|
+
# A unique identifier for a fleet(s) to retrieve capacity information
|
2921
|
+
# for. You can use either the fleet ID or ARN value.
|
2799
2922
|
#
|
2800
2923
|
# @option params [Integer] :limit
|
2801
|
-
#
|
2924
|
+
# The maximum number of results to return. Use this parameter with
|
2802
2925
|
# `NextToken` to get results as a set of sequential pages. This
|
2803
2926
|
# parameter is ignored when the request specifies one or a list of fleet
|
2804
2927
|
# IDs.
|
@@ -2880,15 +3003,7 @@ module Aws::GameLift
|
|
2880
3003
|
#
|
2881
3004
|
# * DescribeFleetEvents
|
2882
3005
|
#
|
2883
|
-
# *
|
2884
|
-
#
|
2885
|
-
# * UpdateFleetAttributes
|
2886
|
-
#
|
2887
|
-
# * UpdateFleetCapacity
|
2888
|
-
#
|
2889
|
-
# * UpdateFleetPortSettings
|
2890
|
-
#
|
2891
|
-
# * UpdateRuntimeConfiguration
|
3006
|
+
# * UpdateFleetAttributes
|
2892
3007
|
#
|
2893
3008
|
# * Manage fleet actions:
|
2894
3009
|
#
|
@@ -2901,7 +3016,8 @@ module Aws::GameLift
|
|
2901
3016
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2902
3017
|
#
|
2903
3018
|
# @option params [required, String] :fleet_id
|
2904
|
-
#
|
3019
|
+
# A unique identifier for a fleet to get event logs for. You can use
|
3020
|
+
# either the fleet ID or ARN value.
|
2905
3021
|
#
|
2906
3022
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
2907
3023
|
# Earliest date to retrieve event logs for. If no start time is
|
@@ -2916,7 +3032,7 @@ module Aws::GameLift
|
|
2916
3032
|
# milliseconds (ex: "1469498468.057").
|
2917
3033
|
#
|
2918
3034
|
# @option params [Integer] :limit
|
2919
|
-
#
|
3035
|
+
# The maximum number of results to return. Use this parameter with
|
2920
3036
|
# `NextToken` to get results as a set of sequential pages.
|
2921
3037
|
#
|
2922
3038
|
# @option params [String] :next_token
|
@@ -2995,15 +3111,7 @@ module Aws::GameLift
|
|
2995
3111
|
#
|
2996
3112
|
# * DescribeFleetEvents
|
2997
3113
|
#
|
2998
|
-
# *
|
2999
|
-
#
|
3000
|
-
# * UpdateFleetAttributes
|
3001
|
-
#
|
3002
|
-
# * UpdateFleetCapacity
|
3003
|
-
#
|
3004
|
-
# * UpdateFleetPortSettings
|
3005
|
-
#
|
3006
|
-
# * UpdateRuntimeConfiguration
|
3114
|
+
# * UpdateFleetAttributes
|
3007
3115
|
#
|
3008
3116
|
# * Manage fleet actions:
|
3009
3117
|
#
|
@@ -3016,7 +3124,8 @@ module Aws::GameLift
|
|
3016
3124
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3017
3125
|
#
|
3018
3126
|
# @option params [required, String] :fleet_id
|
3019
|
-
#
|
3127
|
+
# A unique identifier for a fleet to retrieve port settings for. You can
|
3128
|
+
# use either the fleet ID or ARN value.
|
3020
3129
|
#
|
3021
3130
|
# @return [Types::DescribeFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3022
3131
|
#
|
@@ -3087,15 +3196,7 @@ module Aws::GameLift
|
|
3087
3196
|
#
|
3088
3197
|
# * DescribeFleetEvents
|
3089
3198
|
#
|
3090
|
-
# *
|
3091
|
-
#
|
3092
|
-
# * UpdateFleetAttributes
|
3093
|
-
#
|
3094
|
-
# * UpdateFleetCapacity
|
3095
|
-
#
|
3096
|
-
# * UpdateFleetPortSettings
|
3097
|
-
#
|
3098
|
-
# * UpdateRuntimeConfiguration
|
3199
|
+
# * UpdateFleetAttributes
|
3099
3200
|
#
|
3100
3201
|
# * Manage fleet actions:
|
3101
3202
|
#
|
@@ -3108,11 +3209,11 @@ module Aws::GameLift
|
|
3108
3209
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3109
3210
|
#
|
3110
3211
|
# @option params [Array<String>] :fleet_ids
|
3111
|
-
#
|
3112
|
-
#
|
3212
|
+
# A unique identifier for a fleet(s) to retrieve utilization data for.
|
3213
|
+
# You can use either the fleet ID or ARN value.
|
3113
3214
|
#
|
3114
3215
|
# @option params [Integer] :limit
|
3115
|
-
#
|
3216
|
+
# The maximum number of results to return. Use this parameter with
|
3116
3217
|
# `NextToken` to get results as a set of sequential pages. This
|
3117
3218
|
# parameter is ignored when the request specifies one or a list of fleet
|
3118
3219
|
# IDs.
|
@@ -3190,15 +3291,15 @@ module Aws::GameLift
|
|
3190
3291
|
# * StopGameSessionPlacement
|
3191
3292
|
#
|
3192
3293
|
# @option params [String] :fleet_id
|
3193
|
-
#
|
3194
|
-
# the fleet.
|
3294
|
+
# A unique identifier for a fleet to retrieve all game sessions active
|
3295
|
+
# on the fleet. You can use either the fleet ID or ARN value.
|
3195
3296
|
#
|
3196
3297
|
# @option params [String] :game_session_id
|
3197
|
-
#
|
3298
|
+
# A unique identifier for the game session to retrieve.
|
3198
3299
|
#
|
3199
3300
|
# @option params [String] :alias_id
|
3200
|
-
#
|
3201
|
-
# all game sessions for.
|
3301
|
+
# A unique identifier for an alias associated with the fleet to retrieve
|
3302
|
+
# all game sessions for. You can use either the alias ID or ARN value.
|
3202
3303
|
#
|
3203
3304
|
# @option params [String] :status_filter
|
3204
3305
|
# Game session status to filter results on. Possible game session
|
@@ -3206,7 +3307,7 @@ module Aws::GameLift
|
|
3206
3307
|
# `TERMINATING` (the last two are transitory).
|
3207
3308
|
#
|
3208
3309
|
# @option params [Integer] :limit
|
3209
|
-
#
|
3310
|
+
# The maximum number of results to return. Use this parameter with
|
3210
3311
|
# `NextToken` to get results as a set of sequential pages.
|
3211
3312
|
#
|
3212
3313
|
# @option params [String] :next_token
|
@@ -3236,6 +3337,7 @@ module Aws::GameLift
|
|
3236
3337
|
# resp.game_session_details[0].game_session.game_session_id #=> String
|
3237
3338
|
# resp.game_session_details[0].game_session.name #=> String
|
3238
3339
|
# resp.game_session_details[0].game_session.fleet_id #=> String
|
3340
|
+
# resp.game_session_details[0].game_session.fleet_arn #=> String
|
3239
3341
|
# resp.game_session_details[0].game_session.creation_time #=> Time
|
3240
3342
|
# resp.game_session_details[0].game_session.termination_time #=> Time
|
3241
3343
|
# resp.game_session_details[0].game_session.current_player_session_count #=> Integer
|
@@ -3289,7 +3391,7 @@ module Aws::GameLift
|
|
3289
3391
|
# * StopGameSessionPlacement
|
3290
3392
|
#
|
3291
3393
|
# @option params [required, String] :placement_id
|
3292
|
-
#
|
3394
|
+
# A unique identifier for a game session placement to retrieve.
|
3293
3395
|
#
|
3294
3396
|
# @return [Types::DescribeGameSessionPlacementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3295
3397
|
#
|
@@ -3343,7 +3445,7 @@ module Aws::GameLift
|
|
3343
3445
|
# results as a set of sequential pages. If successful, a
|
3344
3446
|
# GameSessionQueue object is returned for each requested queue. When
|
3345
3447
|
# specifying a list of queues, objects are returned only for queues that
|
3346
|
-
# currently exist in the
|
3448
|
+
# currently exist in the Region.
|
3347
3449
|
#
|
3348
3450
|
# * CreateGameSessionQueue
|
3349
3451
|
#
|
@@ -3354,17 +3456,19 @@ module Aws::GameLift
|
|
3354
3456
|
# * DeleteGameSessionQueue
|
3355
3457
|
#
|
3356
3458
|
# @option params [Array<String>] :names
|
3357
|
-
#
|
3358
|
-
# for all queues, leave
|
3459
|
+
# A list of queue names to retrieve information for. You can use either
|
3460
|
+
# the queue ID or ARN value. To request settings for all queues, leave
|
3461
|
+
# this parameter empty.
|
3359
3462
|
#
|
3360
3463
|
# @option params [Integer] :limit
|
3361
|
-
#
|
3464
|
+
# The maximum number of results to return. Use this parameter with
|
3362
3465
|
# `NextToken` to get results as a set of sequential pages.
|
3363
3466
|
#
|
3364
3467
|
# @option params [String] :next_token
|
3365
|
-
#
|
3366
|
-
# Use the token that is returned with a previous call to this
|
3367
|
-
# start at the beginning of the result set, do not specify a
|
3468
|
+
# A token that indicates the start of the next sequential page of
|
3469
|
+
# results. Use the token that is returned with a previous call to this
|
3470
|
+
# action. To start at the beginning of the result set, do not specify a
|
3471
|
+
# value.
|
3368
3472
|
#
|
3369
3473
|
# @return [Types::DescribeGameSessionQueuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3370
3474
|
#
|
@@ -3436,15 +3540,15 @@ module Aws::GameLift
|
|
3436
3540
|
# * StopGameSessionPlacement
|
3437
3541
|
#
|
3438
3542
|
# @option params [String] :fleet_id
|
3439
|
-
#
|
3543
|
+
# A unique identifier for a fleet to retrieve all game sessions for. You
|
3544
|
+
# can use either the fleet ID or ARN value.
|
3440
3545
|
#
|
3441
3546
|
# @option params [String] :game_session_id
|
3442
|
-
#
|
3443
|
-
# a `GameSessionId` or `GameSessionArn` value.
|
3547
|
+
# A unique identifier for the game session to retrieve.
|
3444
3548
|
#
|
3445
3549
|
# @option params [String] :alias_id
|
3446
|
-
#
|
3447
|
-
# all game sessions for.
|
3550
|
+
# A unique identifier for an alias associated with the fleet to retrieve
|
3551
|
+
# all game sessions for. You can use either the alias ID or ARN value.
|
3448
3552
|
#
|
3449
3553
|
# @option params [String] :status_filter
|
3450
3554
|
# Game session status to filter results on. Possible game session
|
@@ -3452,7 +3556,7 @@ module Aws::GameLift
|
|
3452
3556
|
# `TERMINATING` (the last two are transitory).
|
3453
3557
|
#
|
3454
3558
|
# @option params [Integer] :limit
|
3455
|
-
#
|
3559
|
+
# The maximum number of results to return. Use this parameter with
|
3456
3560
|
# `NextToken` to get results as a set of sequential pages.
|
3457
3561
|
#
|
3458
3562
|
# @option params [String] :next_token
|
@@ -3482,6 +3586,7 @@ module Aws::GameLift
|
|
3482
3586
|
# resp.game_sessions[0].game_session_id #=> String
|
3483
3587
|
# resp.game_sessions[0].name #=> String
|
3484
3588
|
# resp.game_sessions[0].fleet_id #=> String
|
3589
|
+
# resp.game_sessions[0].fleet_arn #=> String
|
3485
3590
|
# resp.game_sessions[0].creation_time #=> Time
|
3486
3591
|
# resp.game_sessions[0].termination_time #=> Time
|
3487
3592
|
# resp.game_sessions[0].current_player_session_count #=> Integer
|
@@ -3519,14 +3624,15 @@ module Aws::GameLift
|
|
3519
3624
|
# successful, an Instance object is returned for each result.
|
3520
3625
|
#
|
3521
3626
|
# @option params [required, String] :fleet_id
|
3522
|
-
#
|
3627
|
+
# A unique identifier for a fleet to retrieve instance information for.
|
3628
|
+
# You can use either the fleet ID or ARN value.
|
3523
3629
|
#
|
3524
3630
|
# @option params [String] :instance_id
|
3525
|
-
#
|
3526
|
-
# or leave blank to retrieve all instances in the fleet.
|
3631
|
+
# A unique identifier for an instance to retrieve. Specify an instance
|
3632
|
+
# ID or leave blank to retrieve all instances in the fleet.
|
3527
3633
|
#
|
3528
3634
|
# @option params [Integer] :limit
|
3529
|
-
#
|
3635
|
+
# The maximum number of results to return. Use this parameter with
|
3530
3636
|
# `NextToken` to get results as a set of sequential pages.
|
3531
3637
|
#
|
3532
3638
|
# @option params [String] :next_token
|
@@ -3605,10 +3711,10 @@ module Aws::GameLift
|
|
3605
3711
|
#
|
3606
3712
|
#
|
3607
3713
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html
|
3608
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
3714
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
|
3609
3715
|
#
|
3610
3716
|
# @option params [required, Array<String>] :ticket_ids
|
3611
|
-
#
|
3717
|
+
# A unique identifier for a matchmaking ticket. You can include up to 10
|
3612
3718
|
# ID values.
|
3613
3719
|
#
|
3614
3720
|
# @return [Types::DescribeMatchmakingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3626,6 +3732,7 @@ module Aws::GameLift
|
|
3626
3732
|
# resp.ticket_list #=> Array
|
3627
3733
|
# resp.ticket_list[0].ticket_id #=> String
|
3628
3734
|
# resp.ticket_list[0].configuration_name #=> String
|
3735
|
+
# resp.ticket_list[0].configuration_arn #=> String
|
3629
3736
|
# resp.ticket_list[0].status #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PLACING", "QUEUED", "REQUIRES_ACCEPTANCE", "SEARCHING", "TIMED_OUT"
|
3630
3737
|
# resp.ticket_list[0].status_reason #=> String
|
3631
3738
|
# resp.ticket_list[0].status_message #=> String
|
@@ -3693,22 +3800,25 @@ module Aws::GameLift
|
|
3693
3800
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/matchmaker-build.html
|
3694
3801
|
#
|
3695
3802
|
# @option params [Array<String>] :names
|
3696
|
-
#
|
3697
|
-
#
|
3803
|
+
# A unique identifier for a matchmaking configuration(s) to retrieve.
|
3804
|
+
# You can use either the configuration name or ARN value. To request all
|
3805
|
+
# existing configurations, leave this parameter empty.
|
3698
3806
|
#
|
3699
3807
|
# @option params [String] :rule_set_name
|
3700
|
-
#
|
3701
|
-
#
|
3808
|
+
# A unique identifier for a matchmaking rule set. You can use either the
|
3809
|
+
# rule set name or ARN value. Use this parameter to retrieve all
|
3810
|
+
# matchmaking configurations that use this rule set.
|
3702
3811
|
#
|
3703
3812
|
# @option params [Integer] :limit
|
3704
|
-
#
|
3813
|
+
# The maximum number of results to return. Use this parameter with
|
3705
3814
|
# `NextToken` to get results as a set of sequential pages. This
|
3706
3815
|
# parameter is limited to 10.
|
3707
3816
|
#
|
3708
3817
|
# @option params [String] :next_token
|
3709
|
-
#
|
3710
|
-
# Use the token that is returned with a previous call to this
|
3711
|
-
# start at the beginning of the result set, do not specify a
|
3818
|
+
# A token that indicates the start of the next sequential page of
|
3819
|
+
# results. Use the token that is returned with a previous call to this
|
3820
|
+
# action. To start at the beginning of the result set, do not specify a
|
3821
|
+
# value.
|
3712
3822
|
#
|
3713
3823
|
# @return [Types::DescribeMatchmakingConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3714
3824
|
#
|
@@ -3718,8 +3828,8 @@ module Aws::GameLift
|
|
3718
3828
|
# @example Request syntax with placeholder values
|
3719
3829
|
#
|
3720
3830
|
# resp = client.describe_matchmaking_configurations({
|
3721
|
-
# names: ["
|
3722
|
-
# rule_set_name: "
|
3831
|
+
# names: ["MatchmakingConfigurationName"],
|
3832
|
+
# rule_set_name: "MatchmakingRuleSetName",
|
3723
3833
|
# limit: 1,
|
3724
3834
|
# next_token: "NonZeroAndMaxString",
|
3725
3835
|
# })
|
@@ -3728,6 +3838,7 @@ module Aws::GameLift
|
|
3728
3838
|
#
|
3729
3839
|
# resp.configurations #=> Array
|
3730
3840
|
# resp.configurations[0].name #=> String
|
3841
|
+
# resp.configurations[0].configuration_arn #=> String
|
3731
3842
|
# resp.configurations[0].description #=> String
|
3732
3843
|
# resp.configurations[0].game_session_queue_arns #=> Array
|
3733
3844
|
# resp.configurations[0].game_session_queue_arns[0] #=> String
|
@@ -3735,6 +3846,7 @@ module Aws::GameLift
|
|
3735
3846
|
# resp.configurations[0].acceptance_timeout_seconds #=> Integer
|
3736
3847
|
# resp.configurations[0].acceptance_required #=> Boolean
|
3737
3848
|
# resp.configurations[0].rule_set_name #=> String
|
3849
|
+
# resp.configurations[0].rule_set_arn #=> String
|
3738
3850
|
# resp.configurations[0].notification_target #=> String
|
3739
3851
|
# resp.configurations[0].additional_player_count #=> Integer
|
3740
3852
|
# resp.configurations[0].custom_event_data #=> String
|
@@ -3756,7 +3868,7 @@ module Aws::GameLift
|
|
3756
3868
|
end
|
3757
3869
|
|
3758
3870
|
# Retrieves the details for FlexMatch matchmaking rule sets. You can
|
3759
|
-
# request all existing rule sets for the
|
3871
|
+
# request all existing rule sets for the Region, or provide a list of
|
3760
3872
|
# one or more rule set names. When requesting multiple items, use the
|
3761
3873
|
# pagination parameters to retrieve results as a set of sequential
|
3762
3874
|
# pages. If successful, a rule set is returned for each requested name.
|
@@ -3790,18 +3902,20 @@ module Aws::GameLift
|
|
3790
3902
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
|
3791
3903
|
#
|
3792
3904
|
# @option params [Array<String>] :names
|
3793
|
-
#
|
3905
|
+
# A list of one or more matchmaking rule set names to retrieve details
|
3794
3906
|
# for. (Note: The rule set name is different from the optional "name"
|
3795
|
-
# field in the rule set body.)
|
3907
|
+
# field in the rule set body.) You can use either the rule set name or
|
3908
|
+
# ARN value.
|
3796
3909
|
#
|
3797
3910
|
# @option params [Integer] :limit
|
3798
|
-
#
|
3911
|
+
# The maximum number of results to return. Use this parameter with
|
3799
3912
|
# `NextToken` to get results as a set of sequential pages.
|
3800
3913
|
#
|
3801
3914
|
# @option params [String] :next_token
|
3802
|
-
#
|
3803
|
-
# Use the token that is returned with a previous call to this
|
3804
|
-
# start at the beginning of the result set, do not specify a
|
3915
|
+
# A token that indicates the start of the next sequential page of
|
3916
|
+
# results. Use the token that is returned with a previous call to this
|
3917
|
+
# action. To start at the beginning of the result set, do not specify a
|
3918
|
+
# value.
|
3805
3919
|
#
|
3806
3920
|
# @return [Types::DescribeMatchmakingRuleSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3807
3921
|
#
|
@@ -3811,7 +3925,7 @@ module Aws::GameLift
|
|
3811
3925
|
# @example Request syntax with placeholder values
|
3812
3926
|
#
|
3813
3927
|
# resp = client.describe_matchmaking_rule_sets({
|
3814
|
-
# names: ["
|
3928
|
+
# names: ["MatchmakingRuleSetName"],
|
3815
3929
|
# limit: 1,
|
3816
3930
|
# next_token: "NonZeroAndMaxString",
|
3817
3931
|
# })
|
@@ -3820,6 +3934,7 @@ module Aws::GameLift
|
|
3820
3934
|
#
|
3821
3935
|
# resp.rule_sets #=> Array
|
3822
3936
|
# resp.rule_sets[0].rule_set_name #=> String
|
3937
|
+
# resp.rule_sets[0].rule_set_arn #=> String
|
3823
3938
|
# resp.rule_sets[0].rule_set_body #=> String
|
3824
3939
|
# resp.rule_sets[0].creation_time #=> Time
|
3825
3940
|
# resp.next_token #=> String
|
@@ -3864,14 +3979,14 @@ module Aws::GameLift
|
|
3864
3979
|
# * StopGameSessionPlacement
|
3865
3980
|
#
|
3866
3981
|
# @option params [String] :game_session_id
|
3867
|
-
#
|
3982
|
+
# A unique identifier for the game session to retrieve player sessions
|
3868
3983
|
# for.
|
3869
3984
|
#
|
3870
3985
|
# @option params [String] :player_id
|
3871
|
-
#
|
3986
|
+
# A unique identifier for a player to retrieve player sessions for.
|
3872
3987
|
#
|
3873
3988
|
# @option params [String] :player_session_id
|
3874
|
-
#
|
3989
|
+
# A unique identifier for a player session to retrieve.
|
3875
3990
|
#
|
3876
3991
|
# @option params [String] :player_session_status_filter
|
3877
3992
|
# Player session status to filter results on.
|
@@ -3892,7 +4007,7 @@ module Aws::GameLift
|
|
3892
4007
|
# limit (60 seconds).
|
3893
4008
|
#
|
3894
4009
|
# @option params [Integer] :limit
|
3895
|
-
#
|
4010
|
+
# The maximum number of results to return. Use this parameter with
|
3896
4011
|
# `NextToken` to get results as a set of sequential pages. If a player
|
3897
4012
|
# session ID is specified, this parameter is ignored.
|
3898
4013
|
#
|
@@ -3925,6 +4040,7 @@ module Aws::GameLift
|
|
3925
4040
|
# resp.player_sessions[0].player_id #=> String
|
3926
4041
|
# resp.player_sessions[0].game_session_id #=> String
|
3927
4042
|
# resp.player_sessions[0].fleet_id #=> String
|
4043
|
+
# resp.player_sessions[0].fleet_arn #=> String
|
3928
4044
|
# resp.player_sessions[0].creation_time #=> Time
|
3929
4045
|
# resp.player_sessions[0].termination_time #=> Time
|
3930
4046
|
# resp.player_sessions[0].status #=> String, one of "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT"
|
@@ -3943,8 +4059,8 @@ module Aws::GameLift
|
|
3943
4059
|
req.send_request(options)
|
3944
4060
|
end
|
3945
4061
|
|
3946
|
-
# Retrieves the current
|
3947
|
-
# The
|
4062
|
+
# Retrieves the current runtime configuration for the specified fleet.
|
4063
|
+
# The runtime configuration tells Amazon GameLift how to launch server
|
3948
4064
|
# processes on instances in the fleet.
|
3949
4065
|
#
|
3950
4066
|
# **Learn more**
|
@@ -3975,15 +4091,7 @@ module Aws::GameLift
|
|
3975
4091
|
#
|
3976
4092
|
# * DescribeFleetEvents
|
3977
4093
|
#
|
3978
|
-
# *
|
3979
|
-
#
|
3980
|
-
# * UpdateFleetAttributes
|
3981
|
-
#
|
3982
|
-
# * UpdateFleetCapacity
|
3983
|
-
#
|
3984
|
-
# * UpdateFleetPortSettings
|
3985
|
-
#
|
3986
|
-
# * UpdateRuntimeConfiguration
|
4094
|
+
# * UpdateFleetAttributes
|
3987
4095
|
#
|
3988
4096
|
# * Manage fleet actions:
|
3989
4097
|
#
|
@@ -3996,7 +4104,8 @@ module Aws::GameLift
|
|
3996
4104
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3997
4105
|
#
|
3998
4106
|
# @option params [required, String] :fleet_id
|
3999
|
-
#
|
4107
|
+
# A unique identifier for a fleet to get the runtime configuration for.
|
4108
|
+
# You can use either the fleet ID or ARN value.
|
4000
4109
|
#
|
4001
4110
|
# @return [Types::DescribeRuntimeConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4002
4111
|
#
|
@@ -4061,7 +4170,8 @@ module Aws::GameLift
|
|
4061
4170
|
# * StopFleetActions
|
4062
4171
|
#
|
4063
4172
|
# @option params [required, String] :fleet_id
|
4064
|
-
#
|
4173
|
+
# A unique identifier for a fleet to retrieve scaling policies for. You
|
4174
|
+
# can use either the fleet ID or ARN value.
|
4065
4175
|
#
|
4066
4176
|
# @option params [String] :status_filter
|
4067
4177
|
# Scaling policy status to filter results on. A scaling policy is only
|
@@ -4085,7 +4195,7 @@ module Aws::GameLift
|
|
4085
4195
|
# removed and recreated.
|
4086
4196
|
#
|
4087
4197
|
# @option params [Integer] :limit
|
4088
|
-
#
|
4198
|
+
# The maximum number of results to return. Use this parameter with
|
4089
4199
|
# `NextToken` to get results as a set of sequential pages.
|
4090
4200
|
#
|
4091
4201
|
# @option params [String] :next_token
|
@@ -4158,7 +4268,8 @@ module Aws::GameLift
|
|
4158
4268
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html
|
4159
4269
|
#
|
4160
4270
|
# @option params [required, String] :script_id
|
4161
|
-
#
|
4271
|
+
# A unique identifier for a Realtime script to retrieve properties for.
|
4272
|
+
# You can use either the script ID or ARN value.
|
4162
4273
|
#
|
4163
4274
|
# @return [Types::DescribeScriptOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4164
4275
|
#
|
@@ -4173,6 +4284,7 @@ module Aws::GameLift
|
|
4173
4284
|
# @example Response structure
|
4174
4285
|
#
|
4175
4286
|
# resp.script.script_id #=> String
|
4287
|
+
# resp.script.script_arn #=> String
|
4176
4288
|
# resp.script.name #=> String
|
4177
4289
|
# resp.script.version #=> String
|
4178
4290
|
# resp.script.size_on_disk #=> Integer
|
@@ -4254,7 +4366,8 @@ module Aws::GameLift
|
|
4254
4366
|
# * DeleteVpcPeeringConnection
|
4255
4367
|
#
|
4256
4368
|
# @option params [String] :fleet_id
|
4257
|
-
#
|
4369
|
+
# A unique identifier for a fleet. You can use either the fleet ID or
|
4370
|
+
# ARN value.
|
4258
4371
|
#
|
4259
4372
|
# @return [Types::DescribeVpcPeeringConnectionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4260
4373
|
#
|
@@ -4270,6 +4383,7 @@ module Aws::GameLift
|
|
4270
4383
|
#
|
4271
4384
|
# resp.vpc_peering_connections #=> Array
|
4272
4385
|
# resp.vpc_peering_connections[0].fleet_id #=> String
|
4386
|
+
# resp.vpc_peering_connections[0].fleet_arn #=> String
|
4273
4387
|
# resp.vpc_peering_connections[0].ip_v4_cidr_block #=> String
|
4274
4388
|
# resp.vpc_peering_connections[0].vpc_peering_connection_id #=> String
|
4275
4389
|
# resp.vpc_peering_connections[0].status.code #=> String
|
@@ -4321,7 +4435,7 @@ module Aws::GameLift
|
|
4321
4435
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift
|
4322
4436
|
#
|
4323
4437
|
# @option params [required, String] :game_session_id
|
4324
|
-
#
|
4438
|
+
# A unique identifier for the game session to get logs for.
|
4325
4439
|
#
|
4326
4440
|
# @return [Types::GetGameSessionLogUrlOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4327
4441
|
#
|
@@ -4372,13 +4486,14 @@ module Aws::GameLift
|
|
4372
4486
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
4373
4487
|
#
|
4374
4488
|
# @option params [required, String] :fleet_id
|
4375
|
-
#
|
4376
|
-
# access to.
|
4377
|
-
#
|
4378
|
-
# be accessible for a short
|
4489
|
+
# A unique identifier for a fleet that contains the instance you want
|
4490
|
+
# access to. You can use either the fleet ID or ARN value. The fleet can
|
4491
|
+
# be in any of the following statuses: `ACTIVATING`, `ACTIVE`, or
|
4492
|
+
# `ERROR`. Fleets with an `ERROR` status may be accessible for a short
|
4493
|
+
# time before they are deleted.
|
4379
4494
|
#
|
4380
4495
|
# @option params [required, String] :instance_id
|
4381
|
-
#
|
4496
|
+
# A unique identifier for an instance you want to get access to. You can
|
4382
4497
|
# access an instance in any status.
|
4383
4498
|
#
|
4384
4499
|
# @return [Types::GetInstanceAccessOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4431,9 +4546,9 @@ module Aws::GameLift
|
|
4431
4546
|
# * ResolveAlias
|
4432
4547
|
#
|
4433
4548
|
# @option params [String] :routing_strategy_type
|
4434
|
-
#
|
4435
|
-
# only aliases
|
4436
|
-
# parameter empty.
|
4549
|
+
# The routing type to filter results on. Use this parameter to retrieve
|
4550
|
+
# only aliases with a certain routing type. To retrieve all aliases,
|
4551
|
+
# leave this parameter empty.
|
4437
4552
|
#
|
4438
4553
|
# Possible routing types include the following:
|
4439
4554
|
#
|
@@ -4446,17 +4561,18 @@ module Aws::GameLift
|
|
4446
4561
|
# message embedded.
|
4447
4562
|
#
|
4448
4563
|
# @option params [String] :name
|
4449
|
-
#
|
4450
|
-
# need to be unique.
|
4564
|
+
# A descriptive label that is associated with an alias. Alias names do
|
4565
|
+
# not need to be unique.
|
4451
4566
|
#
|
4452
4567
|
# @option params [Integer] :limit
|
4453
|
-
#
|
4568
|
+
# The maximum number of results to return. Use this parameter with
|
4454
4569
|
# `NextToken` to get results as a set of sequential pages.
|
4455
4570
|
#
|
4456
4571
|
# @option params [String] :next_token
|
4457
|
-
#
|
4458
|
-
# Use the token that is returned with a previous call to this
|
4459
|
-
# start at the beginning of the result set, do not specify a
|
4572
|
+
# A token that indicates the start of the next sequential page of
|
4573
|
+
# results. Use the token that is returned with a previous call to this
|
4574
|
+
# action. To start at the beginning of the result set, do not specify a
|
4575
|
+
# value.
|
4460
4576
|
#
|
4461
4577
|
# @return [Types::ListAliasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4462
4578
|
#
|
@@ -4542,7 +4658,7 @@ module Aws::GameLift
|
|
4542
4658
|
# fleets for this build.
|
4543
4659
|
#
|
4544
4660
|
# @option params [Integer] :limit
|
4545
|
-
#
|
4661
|
+
# The maximum number of results to return. Use this parameter with
|
4546
4662
|
# `NextToken` to get results as a set of sequential pages.
|
4547
4663
|
#
|
4548
4664
|
# @option params [String] :next_token
|
@@ -4567,6 +4683,7 @@ module Aws::GameLift
|
|
4567
4683
|
#
|
4568
4684
|
# resp.builds #=> Array
|
4569
4685
|
# resp.builds[0].build_id #=> String
|
4686
|
+
# resp.builds[0].build_arn #=> String
|
4570
4687
|
# resp.builds[0].name #=> String
|
4571
4688
|
# resp.builds[0].version #=> String
|
4572
4689
|
# resp.builds[0].status #=> String, one of "INITIALIZED", "READY", "FAILED"
|
@@ -4605,31 +4722,9 @@ module Aws::GameLift
|
|
4605
4722
|
#
|
4606
4723
|
# * DeleteFleet
|
4607
4724
|
#
|
4608
|
-
# *
|
4725
|
+
# * DescribeFleetAttributes
|
4609
4726
|
#
|
4610
|
-
#
|
4611
|
-
#
|
4612
|
-
# * DescribeFleetCapacity
|
4613
|
-
#
|
4614
|
-
# * DescribeFleetPortSettings
|
4615
|
-
#
|
4616
|
-
# * DescribeFleetUtilization
|
4617
|
-
#
|
4618
|
-
# * DescribeRuntimeConfiguration
|
4619
|
-
#
|
4620
|
-
# * DescribeEC2InstanceLimits
|
4621
|
-
#
|
4622
|
-
# * DescribeFleetEvents
|
4623
|
-
#
|
4624
|
-
# * Update fleets:
|
4625
|
-
#
|
4626
|
-
# * UpdateFleetAttributes
|
4627
|
-
#
|
4628
|
-
# * UpdateFleetCapacity
|
4629
|
-
#
|
4630
|
-
# * UpdateFleetPortSettings
|
4631
|
-
#
|
4632
|
-
# * UpdateRuntimeConfiguration
|
4727
|
+
# * UpdateFleetAttributes
|
4633
4728
|
#
|
4634
4729
|
# * Manage fleet actions:
|
4635
4730
|
#
|
@@ -4642,17 +4737,19 @@ module Aws::GameLift
|
|
4642
4737
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
4643
4738
|
#
|
4644
4739
|
# @option params [String] :build_id
|
4645
|
-
#
|
4646
|
-
# to return only fleets using the specified build.
|
4647
|
-
# fleets, leave this parameter
|
4740
|
+
# A unique identifier for a build to return fleets for. Use this
|
4741
|
+
# parameter to return only fleets using the specified build. Use either
|
4742
|
+
# the build ID or ARN value.To retrieve all fleets, leave this parameter
|
4743
|
+
# empty.
|
4648
4744
|
#
|
4649
4745
|
# @option params [String] :script_id
|
4650
|
-
#
|
4651
|
-
# parameter to return only fleets using the specified script.
|
4652
|
-
# retrieve all fleets, leave this
|
4746
|
+
# A unique identifier for a Realtime script to return fleets for. Use
|
4747
|
+
# this parameter to return only fleets using the specified script. Use
|
4748
|
+
# either the script ID or ARN value.To retrieve all fleets, leave this
|
4749
|
+
# parameter empty.
|
4653
4750
|
#
|
4654
4751
|
# @option params [Integer] :limit
|
4655
|
-
#
|
4752
|
+
# The maximum number of results to return. Use this parameter with
|
4656
4753
|
# `NextToken` to get results as a set of sequential pages.
|
4657
4754
|
#
|
4658
4755
|
# @option params [String] :next_token
|
@@ -4713,13 +4810,14 @@ module Aws::GameLift
|
|
4713
4810
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html
|
4714
4811
|
#
|
4715
4812
|
# @option params [Integer] :limit
|
4716
|
-
#
|
4813
|
+
# The maximum number of results to return. Use this parameter with
|
4717
4814
|
# `NextToken` to get results as a set of sequential pages.
|
4718
4815
|
#
|
4719
4816
|
# @option params [String] :next_token
|
4720
|
-
#
|
4721
|
-
# Use the token that is returned with a previous call to this
|
4722
|
-
# start at the beginning of the result set, do not specify a
|
4817
|
+
# A token that indicates the start of the next sequential page of
|
4818
|
+
# results. Use the token that is returned with a previous call to this
|
4819
|
+
# action. To start at the beginning of the result set, do not specify a
|
4820
|
+
# value.
|
4723
4821
|
#
|
4724
4822
|
# @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4725
4823
|
#
|
@@ -4737,6 +4835,7 @@ module Aws::GameLift
|
|
4737
4835
|
#
|
4738
4836
|
# resp.scripts #=> Array
|
4739
4837
|
# resp.scripts[0].script_id #=> String
|
4838
|
+
# resp.scripts[0].script_arn #=> String
|
4740
4839
|
# resp.scripts[0].name #=> String
|
4741
4840
|
# resp.scripts[0].version #=> String
|
4742
4841
|
# resp.scripts[0].size_on_disk #=> Integer
|
@@ -4756,6 +4855,83 @@ module Aws::GameLift
|
|
4756
4855
|
req.send_request(options)
|
4757
4856
|
end
|
4758
4857
|
|
4858
|
+
# Retrieves all tags that are assigned to a GameLift resource. Resource
|
4859
|
+
# tags are used to organize AWS resources for a range of purposes. This
|
4860
|
+
# action handles the permissions necessary to manage tags for the
|
4861
|
+
# following GameLift resource types:
|
4862
|
+
#
|
4863
|
+
# * Build
|
4864
|
+
#
|
4865
|
+
# * Script
|
4866
|
+
#
|
4867
|
+
# * Fleet
|
4868
|
+
#
|
4869
|
+
# * Alias
|
4870
|
+
#
|
4871
|
+
# * GameSessionQueue
|
4872
|
+
#
|
4873
|
+
# * MatchmakingConfiguration
|
4874
|
+
#
|
4875
|
+
# * MatchmakingRuleSet
|
4876
|
+
#
|
4877
|
+
# To list tags for a resource, specify the unique ARN value for the
|
4878
|
+
# resource.
|
4879
|
+
#
|
4880
|
+
# **Learn more**
|
4881
|
+
#
|
4882
|
+
# [Tagging AWS Resources][1] in the *AWS General Reference*
|
4883
|
+
#
|
4884
|
+
# [ AWS Tagging Strategies][2]
|
4885
|
+
#
|
4886
|
+
# **Related operations**
|
4887
|
+
#
|
4888
|
+
# * TagResource
|
4889
|
+
#
|
4890
|
+
# * UntagResource
|
4891
|
+
#
|
4892
|
+
# * ListTagsForResource
|
4893
|
+
#
|
4894
|
+
#
|
4895
|
+
#
|
4896
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
4897
|
+
# [2]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/
|
4898
|
+
#
|
4899
|
+
# @option params [required, String] :resource_arn
|
4900
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
4901
|
+
# identifies the GameLift resource that you want to retrieve tags for.
|
4902
|
+
# GameLift resource ARNs are included in the data object for the
|
4903
|
+
# resource, which can be retrieved by calling a List or Describe action
|
4904
|
+
# for the resource type.
|
4905
|
+
#
|
4906
|
+
#
|
4907
|
+
#
|
4908
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
4909
|
+
#
|
4910
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4911
|
+
#
|
4912
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
4913
|
+
#
|
4914
|
+
# @example Request syntax with placeholder values
|
4915
|
+
#
|
4916
|
+
# resp = client.list_tags_for_resource({
|
4917
|
+
# resource_arn: "AmazonResourceName", # required
|
4918
|
+
# })
|
4919
|
+
#
|
4920
|
+
# @example Response structure
|
4921
|
+
#
|
4922
|
+
# resp.tags #=> Array
|
4923
|
+
# resp.tags[0].key #=> String
|
4924
|
+
# resp.tags[0].value #=> String
|
4925
|
+
#
|
4926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListTagsForResource AWS API Documentation
|
4927
|
+
#
|
4928
|
+
# @overload list_tags_for_resource(params = {})
|
4929
|
+
# @param [Hash] params ({})
|
4930
|
+
def list_tags_for_resource(params = {}, options = {})
|
4931
|
+
req = build_request(:list_tags_for_resource, params)
|
4932
|
+
req.send_request(options)
|
4933
|
+
end
|
4934
|
+
|
4759
4935
|
# Creates or updates a scaling policy for a fleet. Scaling policies are
|
4760
4936
|
# used to automatically scale a fleet's hosting capacity to meet player
|
4761
4937
|
# demand. An active scaling policy instructs Amazon GameLift to track a
|
@@ -4865,19 +5041,20 @@ module Aws::GameLift
|
|
4865
5041
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html
|
4866
5042
|
#
|
4867
5043
|
# @option params [required, String] :name
|
4868
|
-
#
|
5044
|
+
# A descriptive label that is associated with a scaling policy. Policy
|
4869
5045
|
# names do not need to be unique. A fleet can have only one scaling
|
4870
5046
|
# policy with the same name.
|
4871
5047
|
#
|
4872
5048
|
# @option params [required, String] :fleet_id
|
4873
|
-
#
|
4874
|
-
# cannot be in any of the
|
5049
|
+
# A unique identifier for a fleet to apply this policy to. You can use
|
5050
|
+
# either the fleet ID or ARN value. The fleet cannot be in any of the
|
5051
|
+
# following statuses: ERROR or DELETING.
|
4875
5052
|
#
|
4876
5053
|
# @option params [Integer] :scaling_adjustment
|
4877
5054
|
# Amount of adjustment to make, based on the scaling adjustment type.
|
4878
5055
|
#
|
4879
5056
|
# @option params [String] :scaling_adjustment_type
|
4880
|
-
#
|
5057
|
+
# The type of adjustment to make to a fleet's instance count (see
|
4881
5058
|
# FleetCapacity):
|
4882
5059
|
#
|
4883
5060
|
# * **ChangeInCapacity** -- add (or subtract) the scaling adjustment
|
@@ -4949,14 +5126,14 @@ module Aws::GameLift
|
|
4949
5126
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html
|
4950
5127
|
#
|
4951
5128
|
# @option params [String] :policy_type
|
4952
|
-
#
|
4953
|
-
# parameter *MetricName* to 'PercentAvailableGameSessions' and
|
4954
|
-
# a *TargetConfiguration*. For a rule-based policy set the
|
4955
|
-
# parameters: *MetricName*, *ComparisonOperator*, *Threshold*,
|
5129
|
+
# The type of scaling policy to create. For a target-based policy, set
|
5130
|
+
# the parameter *MetricName* to 'PercentAvailableGameSessions' and
|
5131
|
+
# specify a *TargetConfiguration*. For a rule-based policy set the
|
5132
|
+
# following parameters: *MetricName*, *ComparisonOperator*, *Threshold*,
|
4956
5133
|
# *EvaluationPeriods*, *ScalingAdjustmentType*, and *ScalingAdjustment*.
|
4957
5134
|
#
|
4958
5135
|
# @option params [Types::TargetConfiguration] :target_configuration
|
4959
|
-
#
|
5136
|
+
# The settings for a target-based scaling policy.
|
4960
5137
|
#
|
4961
5138
|
# @return [Types::PutScalingPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4962
5139
|
#
|
@@ -5022,7 +5199,8 @@ module Aws::GameLift
|
|
5022
5199
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
5023
5200
|
#
|
5024
5201
|
# @option params [required, String] :build_id
|
5025
|
-
#
|
5202
|
+
# A unique identifier for a build to get credentials for. You can use
|
5203
|
+
# either the build ID or ARN value.
|
5026
5204
|
#
|
5027
5205
|
# @return [Types::RequestUploadCredentialsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5028
5206
|
#
|
@@ -5054,8 +5232,7 @@ module Aws::GameLift
|
|
5054
5232
|
req.send_request(options)
|
5055
5233
|
end
|
5056
5234
|
|
5057
|
-
# Retrieves the fleet ID that
|
5058
|
-
# to.
|
5235
|
+
# Retrieves the fleet ID that an alias is currently pointing to.
|
5059
5236
|
#
|
5060
5237
|
# * CreateAlias
|
5061
5238
|
#
|
@@ -5070,11 +5247,13 @@ module Aws::GameLift
|
|
5070
5247
|
# * ResolveAlias
|
5071
5248
|
#
|
5072
5249
|
# @option params [required, String] :alias_id
|
5073
|
-
#
|
5250
|
+
# The unique identifier of the alias that you want to retrieve a fleet
|
5251
|
+
# ID for. You can use either the alias ID or ARN value.
|
5074
5252
|
#
|
5075
5253
|
# @return [Types::ResolveAliasOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5076
5254
|
#
|
5077
5255
|
# * {Types::ResolveAliasOutput#fleet_id #fleet_id} => String
|
5256
|
+
# * {Types::ResolveAliasOutput#fleet_arn #fleet_arn} => String
|
5078
5257
|
#
|
5079
5258
|
# @example Request syntax with placeholder values
|
5080
5259
|
#
|
@@ -5085,6 +5264,7 @@ module Aws::GameLift
|
|
5085
5264
|
# @example Response structure
|
5086
5265
|
#
|
5087
5266
|
# resp.fleet_id #=> String
|
5267
|
+
# resp.fleet_arn #=> String
|
5088
5268
|
#
|
5089
5269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResolveAlias AWS API Documentation
|
5090
5270
|
#
|
@@ -5099,8 +5279,8 @@ module Aws::GameLift
|
|
5099
5279
|
# and sorts them in a specified order. You can search or sort by the
|
5100
5280
|
# following game session attributes:
|
5101
5281
|
#
|
5102
|
-
# * **gameSessionId** --
|
5103
|
-
# use either a `GameSessionId` or `GameSessionArn` value.
|
5282
|
+
# * **gameSessionId** -- A unique identifier for the game session. You
|
5283
|
+
# can use either a `GameSessionId` or `GameSessionArn` value.
|
5104
5284
|
#
|
5105
5285
|
# * **gameSessionName** -- Name assigned to a game session. This value
|
5106
5286
|
# is set when requesting a new game session with CreateGameSession or
|
@@ -5174,13 +5354,15 @@ module Aws::GameLift
|
|
5174
5354
|
# * StopGameSessionPlacement
|
5175
5355
|
#
|
5176
5356
|
# @option params [String] :fleet_id
|
5177
|
-
#
|
5178
|
-
#
|
5357
|
+
# A unique identifier for a fleet to search for active game sessions.
|
5358
|
+
# You can use either the fleet ID or ARN value. Each request must
|
5359
|
+
# reference either a fleet ID or alias ID, but not both.
|
5179
5360
|
#
|
5180
5361
|
# @option params [String] :alias_id
|
5181
|
-
#
|
5182
|
-
# active game sessions.
|
5183
|
-
# alias ID, but
|
5362
|
+
# A unique identifier for an alias associated with the fleet to search
|
5363
|
+
# for active game sessions. You can use either the alias ID or ARN
|
5364
|
+
# value. Each request must reference either a fleet ID or alias ID, but
|
5365
|
+
# not both.
|
5184
5366
|
#
|
5185
5367
|
# @option params [String] :filter_expression
|
5186
5368
|
# String containing the search criteria for the session search. If no
|
@@ -5246,7 +5428,7 @@ module Aws::GameLift
|
|
5246
5428
|
# null value for the sort operand are returned at the end of the list.
|
5247
5429
|
#
|
5248
5430
|
# @option params [Integer] :limit
|
5249
|
-
#
|
5431
|
+
# The maximum number of results to return. Use this parameter with
|
5250
5432
|
# `NextToken` to get results as a set of sequential pages. The maximum
|
5251
5433
|
# number of results returned is 20, even if this value is not set or is
|
5252
5434
|
# set higher than 20.
|
@@ -5278,6 +5460,7 @@ module Aws::GameLift
|
|
5278
5460
|
# resp.game_sessions[0].game_session_id #=> String
|
5279
5461
|
# resp.game_sessions[0].name #=> String
|
5280
5462
|
# resp.game_sessions[0].fleet_id #=> String
|
5463
|
+
# resp.game_sessions[0].fleet_arn #=> String
|
5281
5464
|
# resp.game_sessions[0].creation_time #=> Time
|
5282
5465
|
# resp.game_sessions[0].termination_time #=> Time
|
5283
5466
|
# resp.game_sessions[0].current_player_session_count #=> Integer
|
@@ -5365,7 +5548,8 @@ module Aws::GameLift
|
|
5365
5548
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
5366
5549
|
#
|
5367
5550
|
# @option params [required, String] :fleet_id
|
5368
|
-
#
|
5551
|
+
# A unique identifier for a fleet to start actions on. You can use
|
5552
|
+
# either the fleet ID or ARN value.
|
5369
5553
|
#
|
5370
5554
|
# @option params [required, Array<String>] :actions
|
5371
5555
|
# List of actions to restart on the fleet.
|
@@ -5403,12 +5587,12 @@ module Aws::GameLift
|
|
5403
5587
|
# Ideally, a queue's destinations are listed in preference order.
|
5404
5588
|
#
|
5405
5589
|
# Alternatively, when requesting a game session with players, you can
|
5406
|
-
# also provide latency data for each player in relevant
|
5590
|
+
# also provide latency data for each player in relevant Regions. Latency
|
5407
5591
|
# data indicates the performance lag a player experiences when connected
|
5408
|
-
# to a fleet in the
|
5409
|
-
# the list of destinations to place the game session in a
|
5592
|
+
# to a fleet in the Region. Amazon GameLift uses latency data to reorder
|
5593
|
+
# the list of destinations to place the game session in a Region with
|
5410
5594
|
# minimal lag. If latency data is provided for multiple players, Amazon
|
5411
|
-
# GameLift calculates each
|
5595
|
+
# GameLift calculates each Region's average lag for all players and
|
5412
5596
|
# reorders to get the best game play across all players.
|
5413
5597
|
#
|
5414
5598
|
# To place a new game session request, specify the following:
|
@@ -5431,7 +5615,7 @@ module Aws::GameLift
|
|
5431
5615
|
# To track the status of a placement request, call
|
5432
5616
|
# DescribeGameSessionPlacement and check the request's status. If the
|
5433
5617
|
# status is `FULFILLED`, a new game session has been created and a game
|
5434
|
-
# session ARN and
|
5618
|
+
# session ARN and Region are referenced. If the placement request times
|
5435
5619
|
# out, you can resubmit the request or retry it with a different queue.
|
5436
5620
|
#
|
5437
5621
|
# * CreateGameSession
|
@@ -5455,13 +5639,14 @@ module Aws::GameLift
|
|
5455
5639
|
# * StopGameSessionPlacement
|
5456
5640
|
#
|
5457
5641
|
# @option params [required, String] :placement_id
|
5458
|
-
#
|
5642
|
+
# A unique identifier to assign to the new game session placement. This
|
5459
5643
|
# value is developer-defined. The value must be unique across all
|
5460
|
-
#
|
5644
|
+
# Regions and cannot be reused unless you are resubmitting a canceled or
|
5461
5645
|
# timed-out placement request.
|
5462
5646
|
#
|
5463
5647
|
# @option params [required, String] :game_session_queue_name
|
5464
|
-
# Name of the queue to use to place the new game session.
|
5648
|
+
# Name of the queue to use to place the new game session. You can use
|
5649
|
+
# either the qieue name or ARN value.
|
5465
5650
|
#
|
5466
5651
|
# @option params [Array<Types::GameProperty>] :game_properties
|
5467
5652
|
# Set of custom properties for a game session, formatted as key:value
|
@@ -5474,16 +5659,16 @@ module Aws::GameLift
|
|
5474
5659
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
5475
5660
|
#
|
5476
5661
|
# @option params [required, Integer] :maximum_player_session_count
|
5477
|
-
#
|
5478
|
-
# game session.
|
5662
|
+
# The maximum number of players that can be connected simultaneously to
|
5663
|
+
# the game session.
|
5479
5664
|
#
|
5480
5665
|
# @option params [String] :game_session_name
|
5481
|
-
#
|
5666
|
+
# A descriptive label that is associated with a game session. Session
|
5482
5667
|
# names do not need to be unique.
|
5483
5668
|
#
|
5484
5669
|
# @option params [Array<Types::PlayerLatency>] :player_latencies
|
5485
5670
|
# Set of values, expressed in milliseconds, indicating the amount of
|
5486
|
-
# latency that a player experiences when connected to AWS
|
5671
|
+
# latency that a player experiences when connected to AWS Regions. This
|
5487
5672
|
# information is used to try to place the new game session where it can
|
5488
5673
|
# offer the best possible gameplay experience for the players.
|
5489
5674
|
#
|
@@ -5620,28 +5805,24 @@ module Aws::GameLift
|
|
5620
5805
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html
|
5621
5806
|
#
|
5622
5807
|
# @option params [String] :ticket_id
|
5623
|
-
#
|
5808
|
+
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
5624
5809
|
# specified here, Amazon GameLift will generate one in the form of a
|
5625
5810
|
# UUID. Use this identifier to track the match backfill ticket status
|
5626
5811
|
# and retrieve match results.
|
5627
5812
|
#
|
5628
5813
|
# @option params [required, String] :configuration_name
|
5629
|
-
# Name of the matchmaker to use for this request.
|
5630
|
-
#
|
5631
|
-
# the
|
5632
|
-
#
|
5633
|
-
# matchmaker name. (In the ARN value
|
5634
|
-
# "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4",
|
5635
|
-
# the matchmaking configuration name is "MM-4v4".) Use only the name
|
5636
|
-
# for this parameter.
|
5814
|
+
# Name of the matchmaker to use for this request. You can use either the
|
5815
|
+
# configuration name or ARN value. The ARN of the matchmaker that was
|
5816
|
+
# used with the original game session is listed in the GameSession
|
5817
|
+
# object, `MatchmakerData` property.
|
5637
5818
|
#
|
5638
5819
|
# @option params [required, String] :game_session_arn
|
5639
5820
|
# Amazon Resource Name ([ARN][1]) that is assigned to a game session and
|
5640
|
-
# uniquely identifies it.
|
5821
|
+
# uniquely identifies it. This is the same as the game session ID.
|
5641
5822
|
#
|
5642
5823
|
#
|
5643
5824
|
#
|
5644
|
-
# [1]: https://docs.aws.amazon.com/
|
5825
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5645
5826
|
#
|
5646
5827
|
# @option params [required, Array<Types::Player>] :players
|
5647
5828
|
# Match information on all players that are currently assigned to the
|
@@ -5655,8 +5836,8 @@ module Aws::GameLift
|
|
5655
5836
|
# details, see [ Match Data][1].
|
5656
5837
|
#
|
5657
5838
|
# * LatencyInMs -\\\\- If the matchmaker uses player latency, include a
|
5658
|
-
# latency value, in milliseconds, for the
|
5659
|
-
# is currently in. Do not include latency values for any other
|
5839
|
+
# latency value, in milliseconds, for the Region that the game session
|
5840
|
+
# is currently in. Do not include latency values for any other Region.
|
5660
5841
|
#
|
5661
5842
|
#
|
5662
5843
|
#
|
@@ -5670,7 +5851,7 @@ module Aws::GameLift
|
|
5670
5851
|
#
|
5671
5852
|
# resp = client.start_match_backfill({
|
5672
5853
|
# ticket_id: "MatchmakingIdStringModel",
|
5673
|
-
# configuration_name: "
|
5854
|
+
# configuration_name: "MatchmakingConfigurationName", # required
|
5674
5855
|
# game_session_arn: "ArnStringModel", # required
|
5675
5856
|
# players: [ # required
|
5676
5857
|
# {
|
@@ -5690,6 +5871,7 @@ module Aws::GameLift
|
|
5690
5871
|
#
|
5691
5872
|
# resp.matchmaking_ticket.ticket_id #=> String
|
5692
5873
|
# resp.matchmaking_ticket.configuration_name #=> String
|
5874
|
+
# resp.matchmaking_ticket.configuration_arn #=> String
|
5693
5875
|
# resp.matchmaking_ticket.status #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PLACING", "QUEUED", "REQUIRES_ACCEPTANCE", "SEARCHING", "TIMED_OUT"
|
5694
5876
|
# resp.matchmaking_ticket.status_reason #=> String
|
5695
5877
|
# resp.matchmaking_ticket.status_message #=> String
|
@@ -5817,15 +5999,15 @@ module Aws::GameLift
|
|
5817
5999
|
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-match.html
|
5818
6000
|
#
|
5819
6001
|
# @option params [String] :ticket_id
|
5820
|
-
#
|
6002
|
+
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
5821
6003
|
# specified here, Amazon GameLift will generate one in the form of a
|
5822
6004
|
# UUID. Use this identifier to track the matchmaking ticket status and
|
5823
6005
|
# retrieve match results.
|
5824
6006
|
#
|
5825
6007
|
# @option params [required, String] :configuration_name
|
5826
6008
|
# Name of the matchmaking configuration to use for this request.
|
5827
|
-
# Matchmaking configurations must exist in the same
|
5828
|
-
# request.
|
6009
|
+
# Matchmaking configurations must exist in the same Region as this
|
6010
|
+
# request. You can use either the configuration name or ARN value.
|
5829
6011
|
#
|
5830
6012
|
# @option params [required, Array<Types::Player>] :players
|
5831
6013
|
# Information on each player to be matched. This information must
|
@@ -5842,7 +6024,7 @@ module Aws::GameLift
|
|
5842
6024
|
#
|
5843
6025
|
# resp = client.start_matchmaking({
|
5844
6026
|
# ticket_id: "MatchmakingIdStringModel",
|
5845
|
-
# configuration_name: "
|
6027
|
+
# configuration_name: "MatchmakingConfigurationName", # required
|
5846
6028
|
# players: [ # required
|
5847
6029
|
# {
|
5848
6030
|
# player_id: "NonZeroAndMaxString",
|
@@ -5861,6 +6043,7 @@ module Aws::GameLift
|
|
5861
6043
|
#
|
5862
6044
|
# resp.matchmaking_ticket.ticket_id #=> String
|
5863
6045
|
# resp.matchmaking_ticket.configuration_name #=> String
|
6046
|
+
# resp.matchmaking_ticket.configuration_arn #=> String
|
5864
6047
|
# resp.matchmaking_ticket.status #=> String, one of "CANCELLED", "COMPLETED", "FAILED", "PLACING", "QUEUED", "REQUIRES_ACCEPTANCE", "SEARCHING", "TIMED_OUT"
|
5865
6048
|
# resp.matchmaking_ticket.status_reason #=> String
|
5866
6049
|
# resp.matchmaking_ticket.status_message #=> String
|
@@ -5953,7 +6136,8 @@ module Aws::GameLift
|
|
5953
6136
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
5954
6137
|
#
|
5955
6138
|
# @option params [required, String] :fleet_id
|
5956
|
-
#
|
6139
|
+
# A unique identifier for a fleet to stop actions on. You can use either
|
6140
|
+
# the fleet ID or ARN value.
|
5957
6141
|
#
|
5958
6142
|
# @option params [required, Array<String>] :actions
|
5959
6143
|
# List of actions to suspend on the fleet.
|
@@ -6001,7 +6185,7 @@ module Aws::GameLift
|
|
6001
6185
|
# * StopGameSessionPlacement
|
6002
6186
|
#
|
6003
6187
|
# @option params [required, String] :placement_id
|
6004
|
-
#
|
6188
|
+
# A unique identifier for a game session placement to cancel.
|
6005
6189
|
#
|
6006
6190
|
# @return [Types::StopGameSessionPlacementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6007
6191
|
#
|
@@ -6087,7 +6271,7 @@ module Aws::GameLift
|
|
6087
6271
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html
|
6088
6272
|
#
|
6089
6273
|
# @option params [required, String] :ticket_id
|
6090
|
-
#
|
6274
|
+
# A unique identifier for a matchmaking ticket.
|
6091
6275
|
#
|
6092
6276
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6093
6277
|
#
|
@@ -6106,6 +6290,172 @@ module Aws::GameLift
|
|
6106
6290
|
req.send_request(options)
|
6107
6291
|
end
|
6108
6292
|
|
6293
|
+
# Assigns a tag to a GameLift resource. AWS resource tags provide an
|
6294
|
+
# additional management tool set. You can use tags to organize
|
6295
|
+
# resources, create IAM permissions policies to manage access to groups
|
6296
|
+
# of resources, customize AWS cost breakdowns, etc. This action handles
|
6297
|
+
# the permissions necessary to manage tags for the following GameLift
|
6298
|
+
# resource types:
|
6299
|
+
#
|
6300
|
+
# * Build
|
6301
|
+
#
|
6302
|
+
# * Script
|
6303
|
+
#
|
6304
|
+
# * Fleet
|
6305
|
+
#
|
6306
|
+
# * Alias
|
6307
|
+
#
|
6308
|
+
# * GameSessionQueue
|
6309
|
+
#
|
6310
|
+
# * MatchmakingConfiguration
|
6311
|
+
#
|
6312
|
+
# * MatchmakingRuleSet
|
6313
|
+
#
|
6314
|
+
# To add a tag to a resource, specify the unique ARN value for the
|
6315
|
+
# resource and provide a trig list containing one or more tags. The
|
6316
|
+
# operation succeeds even if the list includes tags that are already
|
6317
|
+
# assigned to the specified resource.
|
6318
|
+
#
|
6319
|
+
# **Learn more**
|
6320
|
+
#
|
6321
|
+
# [Tagging AWS Resources][1] in the *AWS General Reference*
|
6322
|
+
#
|
6323
|
+
# [ AWS Tagging Strategies][2]
|
6324
|
+
#
|
6325
|
+
# **Related operations**
|
6326
|
+
#
|
6327
|
+
# * TagResource
|
6328
|
+
#
|
6329
|
+
# * UntagResource
|
6330
|
+
#
|
6331
|
+
# * ListTagsForResource
|
6332
|
+
#
|
6333
|
+
#
|
6334
|
+
#
|
6335
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6336
|
+
# [2]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/
|
6337
|
+
#
|
6338
|
+
# @option params [required, String] :resource_arn
|
6339
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
6340
|
+
# identifies the GameLift resource that you want to assign tags to.
|
6341
|
+
# GameLift resource ARNs are included in the data object for the
|
6342
|
+
# resource, which can be retrieved by calling a List or Describe action
|
6343
|
+
# for the resource type.
|
6344
|
+
#
|
6345
|
+
#
|
6346
|
+
#
|
6347
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
6348
|
+
#
|
6349
|
+
# @option params [required, Array<Types::Tag>] :tags
|
6350
|
+
# A list of one or more tags to assign to the specified GameLift
|
6351
|
+
# resource. Tags are developer-defined and structured as key-value
|
6352
|
+
# pairs. The maximum tag limit may be lower than stated. See [ Tagging
|
6353
|
+
# AWS Resources][1] for actual tagging limits.
|
6354
|
+
#
|
6355
|
+
#
|
6356
|
+
#
|
6357
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6358
|
+
#
|
6359
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6360
|
+
#
|
6361
|
+
# @example Request syntax with placeholder values
|
6362
|
+
#
|
6363
|
+
# resp = client.tag_resource({
|
6364
|
+
# resource_arn: "AmazonResourceName", # required
|
6365
|
+
# tags: [ # required
|
6366
|
+
# {
|
6367
|
+
# key: "TagKey", # required
|
6368
|
+
# value: "TagValue", # required
|
6369
|
+
# },
|
6370
|
+
# ],
|
6371
|
+
# })
|
6372
|
+
#
|
6373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TagResource AWS API Documentation
|
6374
|
+
#
|
6375
|
+
# @overload tag_resource(params = {})
|
6376
|
+
# @param [Hash] params ({})
|
6377
|
+
def tag_resource(params = {}, options = {})
|
6378
|
+
req = build_request(:tag_resource, params)
|
6379
|
+
req.send_request(options)
|
6380
|
+
end
|
6381
|
+
|
6382
|
+
# Removes a tag that is assigned to a GameLift resource. Resource tags
|
6383
|
+
# are used to organize AWS resources for a range of purposes. This
|
6384
|
+
# action handles the permissions necessary to manage tags for the
|
6385
|
+
# following GameLift resource types:
|
6386
|
+
#
|
6387
|
+
# * Build
|
6388
|
+
#
|
6389
|
+
# * Script
|
6390
|
+
#
|
6391
|
+
# * Fleet
|
6392
|
+
#
|
6393
|
+
# * Alias
|
6394
|
+
#
|
6395
|
+
# * GameSessionQueue
|
6396
|
+
#
|
6397
|
+
# * MatchmakingConfiguration
|
6398
|
+
#
|
6399
|
+
# * MatchmakingRuleSet
|
6400
|
+
#
|
6401
|
+
# To remove a tag from a resource, specify the unique ARN value for the
|
6402
|
+
# resource and provide a string list containing one or more tags to be
|
6403
|
+
# removed. This action succeeds even if the list includes tags that are
|
6404
|
+
# not currently assigned to the specified resource.
|
6405
|
+
#
|
6406
|
+
# **Learn more**
|
6407
|
+
#
|
6408
|
+
# [Tagging AWS Resources][1] in the *AWS General Reference*
|
6409
|
+
#
|
6410
|
+
# [ AWS Tagging Strategies][2]
|
6411
|
+
#
|
6412
|
+
# **Related operations**
|
6413
|
+
#
|
6414
|
+
# * TagResource
|
6415
|
+
#
|
6416
|
+
# * UntagResource
|
6417
|
+
#
|
6418
|
+
# * ListTagsForResource
|
6419
|
+
#
|
6420
|
+
#
|
6421
|
+
#
|
6422
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6423
|
+
# [2]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/
|
6424
|
+
#
|
6425
|
+
# @option params [required, String] :resource_arn
|
6426
|
+
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
6427
|
+
# identifies the GameLift resource that you want to remove tags from.
|
6428
|
+
# GameLift resource ARNs are included in the data object for the
|
6429
|
+
# resource, which can be retrieved by calling a List or Describe action
|
6430
|
+
# for the resource type.
|
6431
|
+
#
|
6432
|
+
#
|
6433
|
+
#
|
6434
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
6435
|
+
#
|
6436
|
+
# @option params [required, Array<String>] :tag_keys
|
6437
|
+
# A list of one or more tags to remove from the specified GameLift
|
6438
|
+
# resource. Tags are developer-defined and structured as key-value
|
6439
|
+
# pairs.
|
6440
|
+
#
|
6441
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6442
|
+
#
|
6443
|
+
# @example Request syntax with placeholder values
|
6444
|
+
#
|
6445
|
+
# resp = client.untag_resource({
|
6446
|
+
# resource_arn: "AmazonResourceName", # required
|
6447
|
+
# tag_keys: ["TagKey"], # required
|
6448
|
+
# })
|
6449
|
+
#
|
6450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UntagResource AWS API Documentation
|
6451
|
+
#
|
6452
|
+
# @overload untag_resource(params = {})
|
6453
|
+
# @param [Hash] params ({})
|
6454
|
+
def untag_resource(params = {}, options = {})
|
6455
|
+
req = build_request(:untag_resource, params)
|
6456
|
+
req.send_request(options)
|
6457
|
+
end
|
6458
|
+
|
6109
6459
|
# Updates properties for an alias. To update properties, specify the
|
6110
6460
|
# alias ID to be updated and provide the information to be changed. To
|
6111
6461
|
# reassign an alias to another fleet, provide an updated routing
|
@@ -6124,18 +6474,19 @@ module Aws::GameLift
|
|
6124
6474
|
# * ResolveAlias
|
6125
6475
|
#
|
6126
6476
|
# @option params [required, String] :alias_id
|
6127
|
-
#
|
6128
|
-
#
|
6477
|
+
# A unique identifier for the alias that you want to update. You can use
|
6478
|
+
# either the alias ID or ARN value.
|
6129
6479
|
#
|
6130
6480
|
# @option params [String] :name
|
6131
|
-
#
|
6132
|
-
# need to be unique.
|
6481
|
+
# A descriptive label that is associated with an alias. Alias names do
|
6482
|
+
# not need to be unique.
|
6133
6483
|
#
|
6134
6484
|
# @option params [String] :description
|
6135
|
-
#
|
6485
|
+
# A human-readable description of the alias.
|
6136
6486
|
#
|
6137
6487
|
# @option params [Types::RoutingStrategy] :routing_strategy
|
6138
|
-
#
|
6488
|
+
# The routing configuration, including routing type and fleet target,
|
6489
|
+
# for the alias.
|
6139
6490
|
#
|
6140
6491
|
# @return [Types::UpdateAliasOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6141
6492
|
#
|
@@ -6201,15 +6552,16 @@ module Aws::GameLift
|
|
6201
6552
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
6202
6553
|
#
|
6203
6554
|
# @option params [required, String] :build_id
|
6204
|
-
#
|
6555
|
+
# A unique identifier for a build to update. You can use either the
|
6556
|
+
# build ID or ARN value.
|
6205
6557
|
#
|
6206
6558
|
# @option params [String] :name
|
6207
|
-
#
|
6208
|
-
# need to be unique.
|
6559
|
+
# A descriptive label that is associated with a build. Build names do
|
6560
|
+
# not need to be unique.
|
6209
6561
|
#
|
6210
6562
|
# @option params [String] :version
|
6211
|
-
# Version that is associated with a build or script. Version
|
6212
|
-
# not need to be unique.
|
6563
|
+
# Version information that is associated with a build or script. Version
|
6564
|
+
# strings do not need to be unique.
|
6213
6565
|
#
|
6214
6566
|
# @return [Types::UpdateBuildOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6215
6567
|
#
|
@@ -6226,6 +6578,7 @@ module Aws::GameLift
|
|
6226
6578
|
# @example Response structure
|
6227
6579
|
#
|
6228
6580
|
# resp.build.build_id #=> String
|
6581
|
+
# resp.build.build_arn #=> String
|
6229
6582
|
# resp.build.name #=> String
|
6230
6583
|
# resp.build.version #=> String
|
6231
6584
|
# resp.build.status #=> String, one of "INITIALIZED", "READY", "FAILED"
|
@@ -6259,21 +6612,7 @@ module Aws::GameLift
|
|
6259
6612
|
#
|
6260
6613
|
# * DeleteFleet
|
6261
6614
|
#
|
6262
|
-
# *
|
6263
|
-
#
|
6264
|
-
# * DescribeFleetAttributes
|
6265
|
-
#
|
6266
|
-
# * DescribeFleetCapacity
|
6267
|
-
#
|
6268
|
-
# * DescribeFleetPortSettings
|
6269
|
-
#
|
6270
|
-
# * DescribeFleetUtilization
|
6271
|
-
#
|
6272
|
-
# * DescribeRuntimeConfiguration
|
6273
|
-
#
|
6274
|
-
# * DescribeEC2InstanceLimits
|
6275
|
-
#
|
6276
|
-
# * DescribeFleetEvents
|
6615
|
+
# * DescribeFleetAttributes
|
6277
6616
|
#
|
6278
6617
|
# * Update fleets:
|
6279
6618
|
#
|
@@ -6296,11 +6635,12 @@ module Aws::GameLift
|
|
6296
6635
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
6297
6636
|
#
|
6298
6637
|
# @option params [required, String] :fleet_id
|
6299
|
-
#
|
6638
|
+
# A unique identifier for a fleet to update attribute metadata for. You
|
6639
|
+
# can use either the fleet ID or ARN value.
|
6300
6640
|
#
|
6301
6641
|
# @option params [String] :name
|
6302
|
-
#
|
6303
|
-
# need to be unique.
|
6642
|
+
# A descriptive label that is associated with a fleet. Fleet names do
|
6643
|
+
# not need to be unique.
|
6304
6644
|
#
|
6305
6645
|
# @option params [String] :description
|
6306
6646
|
# Human-readable description of a fleet.
|
@@ -6390,21 +6730,7 @@ module Aws::GameLift
|
|
6390
6730
|
#
|
6391
6731
|
# * DeleteFleet
|
6392
6732
|
#
|
6393
|
-
# *
|
6394
|
-
#
|
6395
|
-
# * DescribeFleetAttributes
|
6396
|
-
#
|
6397
|
-
# * DescribeFleetCapacity
|
6398
|
-
#
|
6399
|
-
# * DescribeFleetPortSettings
|
6400
|
-
#
|
6401
|
-
# * DescribeFleetUtilization
|
6402
|
-
#
|
6403
|
-
# * DescribeRuntimeConfiguration
|
6404
|
-
#
|
6405
|
-
# * DescribeEC2InstanceLimits
|
6406
|
-
#
|
6407
|
-
# * DescribeFleetEvents
|
6733
|
+
# * DescribeFleetAttributes
|
6408
6734
|
#
|
6409
6735
|
# * Update fleets:
|
6410
6736
|
#
|
@@ -6427,18 +6753,19 @@ module Aws::GameLift
|
|
6427
6753
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
6428
6754
|
#
|
6429
6755
|
# @option params [required, String] :fleet_id
|
6430
|
-
#
|
6756
|
+
# A unique identifier for a fleet to update capacity for. You can use
|
6757
|
+
# either the fleet ID or ARN value.
|
6431
6758
|
#
|
6432
6759
|
# @option params [Integer] :desired_instances
|
6433
6760
|
# Number of EC2 instances you want this fleet to host.
|
6434
6761
|
#
|
6435
6762
|
# @option params [Integer] :min_size
|
6436
|
-
#
|
6437
|
-
# set is 0.
|
6763
|
+
# The minimum value allowed for the fleet's instance count. Default if
|
6764
|
+
# not set is 0.
|
6438
6765
|
#
|
6439
6766
|
# @option params [Integer] :max_size
|
6440
|
-
#
|
6441
|
-
# set is 1.
|
6767
|
+
# The maximum value allowed for the fleet's instance count. Default if
|
6768
|
+
# not set is 1.
|
6442
6769
|
#
|
6443
6770
|
# @return [Types::UpdateFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6444
6771
|
#
|
@@ -6486,21 +6813,7 @@ module Aws::GameLift
|
|
6486
6813
|
#
|
6487
6814
|
# * DeleteFleet
|
6488
6815
|
#
|
6489
|
-
# *
|
6490
|
-
#
|
6491
|
-
# * DescribeFleetAttributes
|
6492
|
-
#
|
6493
|
-
# * DescribeFleetCapacity
|
6494
|
-
#
|
6495
|
-
# * DescribeFleetPortSettings
|
6496
|
-
#
|
6497
|
-
# * DescribeFleetUtilization
|
6498
|
-
#
|
6499
|
-
# * DescribeRuntimeConfiguration
|
6500
|
-
#
|
6501
|
-
# * DescribeEC2InstanceLimits
|
6502
|
-
#
|
6503
|
-
# * DescribeFleetEvents
|
6816
|
+
# * DescribeFleetAttributes
|
6504
6817
|
#
|
6505
6818
|
# * Update fleets:
|
6506
6819
|
#
|
@@ -6523,13 +6836,14 @@ module Aws::GameLift
|
|
6523
6836
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
6524
6837
|
#
|
6525
6838
|
# @option params [required, String] :fleet_id
|
6526
|
-
#
|
6839
|
+
# A unique identifier for a fleet to update port settings for. You can
|
6840
|
+
# use either the fleet ID or ARN value.
|
6527
6841
|
#
|
6528
6842
|
# @option params [Array<Types::IpPermission>] :inbound_permission_authorizations
|
6529
|
-
#
|
6843
|
+
# A collection of port settings to be added to the fleet record.
|
6530
6844
|
#
|
6531
6845
|
# @option params [Array<Types::IpPermission>] :inbound_permission_revocations
|
6532
|
-
#
|
6846
|
+
# A collection of port settings to be removed from the fleet record.
|
6533
6847
|
#
|
6534
6848
|
# @return [Types::UpdateFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6535
6849
|
#
|
@@ -6599,14 +6913,14 @@ module Aws::GameLift
|
|
6599
6913
|
# * StopGameSessionPlacement
|
6600
6914
|
#
|
6601
6915
|
# @option params [required, String] :game_session_id
|
6602
|
-
#
|
6916
|
+
# A unique identifier for the game session to update.
|
6603
6917
|
#
|
6604
6918
|
# @option params [Integer] :maximum_player_session_count
|
6605
|
-
#
|
6606
|
-
# game session.
|
6919
|
+
# The maximum number of players that can be connected simultaneously to
|
6920
|
+
# the game session.
|
6607
6921
|
#
|
6608
6922
|
# @option params [String] :name
|
6609
|
-
#
|
6923
|
+
# A descriptive label that is associated with a game session. Session
|
6610
6924
|
# names do not need to be unique.
|
6611
6925
|
#
|
6612
6926
|
# @option params [String] :player_session_creation_policy
|
@@ -6641,6 +6955,7 @@ module Aws::GameLift
|
|
6641
6955
|
# resp.game_session.game_session_id #=> String
|
6642
6956
|
# resp.game_session.name #=> String
|
6643
6957
|
# resp.game_session.fleet_id #=> String
|
6958
|
+
# resp.game_session.fleet_arn #=> String
|
6644
6959
|
# resp.game_session.creation_time #=> Time
|
6645
6960
|
# resp.game_session.termination_time #=> Time
|
6646
6961
|
# resp.game_session.current_player_session_count #=> Integer
|
@@ -6681,28 +6996,29 @@ module Aws::GameLift
|
|
6681
6996
|
# * DeleteGameSessionQueue
|
6682
6997
|
#
|
6683
6998
|
# @option params [required, String] :name
|
6684
|
-
#
|
6685
|
-
# names must be unique within each
|
6999
|
+
# A descriptive label that is associated with game session queue. Queue
|
7000
|
+
# names must be unique within each Region. You can use either the queue
|
7001
|
+
# ID or ARN value.
|
6686
7002
|
#
|
6687
7003
|
# @option params [Integer] :timeout_in_seconds
|
6688
|
-
#
|
6689
|
-
# remains in the queue. When a request exceeds this time, the
|
6690
|
-
# session placement changes to a `TIMED_OUT` status.
|
7004
|
+
# The maximum time, in seconds, that a new game session placement
|
7005
|
+
# request remains in the queue. When a request exceeds this time, the
|
7006
|
+
# game session placement changes to a `TIMED_OUT` status.
|
6691
7007
|
#
|
6692
7008
|
# @option params [Array<Types::PlayerLatencyPolicy>] :player_latency_policies
|
6693
|
-
#
|
6694
|
-
# placement requests with player latency information. Multiple
|
6695
|
-
# are evaluated in order of the maximum latency value, starting
|
6696
|
-
# lowest latency values. With just one policy,
|
6697
|
-
# start of the game session placement for the duration
|
6698
|
-
# multiple policies, each policy is enforced consecutively
|
6699
|
-
# duration period. For example, a queue might enforce a
|
6700
|
-
# followed by a 120-second policy, and then no policy
|
6701
|
-
# of the placement. When updating policies, provide a
|
6702
|
-
# collection of policies.
|
7009
|
+
# A collection of latency policies to apply when processing game
|
7010
|
+
# sessions placement requests with player latency information. Multiple
|
7011
|
+
# policies are evaluated in order of the maximum latency value, starting
|
7012
|
+
# with the lowest latency values. With just one policy, the policy is
|
7013
|
+
# enforced at the start of the game session placement for the duration
|
7014
|
+
# period. With multiple policies, each policy is enforced consecutively
|
7015
|
+
# for its duration period. For example, a queue might enforce a
|
7016
|
+
# 60-second policy followed by a 120-second policy, and then no policy
|
7017
|
+
# for the remainder of the placement. When updating policies, provide a
|
7018
|
+
# complete collection of policies.
|
6703
7019
|
#
|
6704
7020
|
# @option params [Array<Types::GameSessionQueueDestination>] :destinations
|
6705
|
-
#
|
7021
|
+
# A list of fleets that can be used to fulfill game session placement
|
6706
7022
|
# requests in the queue. Fleets are identified by either a fleet ARN or
|
6707
7023
|
# a fleet alias ARN. Destinations are listed in default preference
|
6708
7024
|
# order. When updating this list, provide a complete list of
|
@@ -6782,63 +7098,66 @@ module Aws::GameLift
|
|
6782
7098
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-configuration.html
|
6783
7099
|
#
|
6784
7100
|
# @option params [required, String] :name
|
6785
|
-
#
|
7101
|
+
# A unique identifier for a matchmaking configuration to update. You can
|
7102
|
+
# use either the configuration name or ARN value.
|
6786
7103
|
#
|
6787
7104
|
# @option params [String] :description
|
6788
|
-
#
|
7105
|
+
# A descriptive label that is associated with matchmaking configuration.
|
6789
7106
|
#
|
6790
7107
|
# @option params [Array<String>] :game_session_queue_arns
|
6791
|
-
# Amazon Resource Name ([ARN][1]) that is assigned to a game
|
6792
|
-
# queue and uniquely identifies it.
|
6793
|
-
#
|
6794
|
-
#
|
6795
|
-
#
|
6796
|
-
# located in any region.
|
7108
|
+
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
7109
|
+
# session queue resource and uniquely identifies it. ARNs are unique
|
7110
|
+
# across all Regions. These queues are used when placing game sessions
|
7111
|
+
# for matches that are created with this matchmaking configuration.
|
7112
|
+
# Queues can be located in any Region.
|
6797
7113
|
#
|
6798
7114
|
#
|
6799
7115
|
#
|
6800
|
-
# [1]: https://docs.aws.amazon.com/
|
7116
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
6801
7117
|
#
|
6802
7118
|
# @option params [Integer] :request_timeout_seconds
|
6803
|
-
#
|
6804
|
-
# process before timing out. Requests that fail due to timing out can
|
6805
|
-
# resubmitted as needed.
|
7119
|
+
# The maximum duration, in seconds, that a matchmaking ticket can remain
|
7120
|
+
# in process before timing out. Requests that fail due to timing out can
|
7121
|
+
# be resubmitted as needed.
|
6806
7122
|
#
|
6807
7123
|
# @option params [Integer] :acceptance_timeout_seconds
|
6808
|
-
#
|
6809
|
-
# match. If any player rejects the match or fails to accept
|
6810
|
-
# timeout, the ticket continues to look for an acceptable
|
7124
|
+
# The length of time (in seconds) to wait for players to accept a
|
7125
|
+
# proposed match. If any player rejects the match or fails to accept
|
7126
|
+
# before the timeout, the ticket continues to look for an acceptable
|
7127
|
+
# match.
|
6811
7128
|
#
|
6812
7129
|
# @option params [Boolean] :acceptance_required
|
6813
|
-
#
|
7130
|
+
# A flag that indicates whether a match that was created with this
|
6814
7131
|
# configuration must be accepted by the matched players. To require
|
6815
7132
|
# acceptance, set to TRUE.
|
6816
7133
|
#
|
6817
7134
|
# @option params [String] :rule_set_name
|
6818
|
-
#
|
6819
|
-
# configuration.
|
6820
|
-
# are defined in
|
7135
|
+
# A unique identifier for a matchmaking rule set to use with this
|
7136
|
+
# configuration. You can use either the rule set name or ARN value. A
|
7137
|
+
# matchmaking configuration can only use rule sets that are defined in
|
7138
|
+
# the same Region.
|
6821
7139
|
#
|
6822
7140
|
# @option params [String] :notification_target
|
6823
|
-
# SNS topic ARN that is set up to receive matchmaking notifications.
|
6824
|
-
# [ Setting up Notifications for Matchmaking][1] for more
|
7141
|
+
# An SNS topic ARN that is set up to receive matchmaking notifications.
|
7142
|
+
# See [ Setting up Notifications for Matchmaking][1] for more
|
7143
|
+
# information.
|
6825
7144
|
#
|
6826
7145
|
#
|
6827
7146
|
#
|
6828
7147
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
|
6829
7148
|
#
|
6830
7149
|
# @option params [Integer] :additional_player_count
|
6831
|
-
#
|
6832
|
-
# example,
|
6833
|
-
# single 12-person team
|
6834
|
-
# only 10 players are selected for the match.
|
7150
|
+
# The number of player slots in a match to keep open for future players.
|
7151
|
+
# For example, assume that the configuration's rule set specifies a
|
7152
|
+
# match for a single 12-person team. If the additional player count is
|
7153
|
+
# set to 2, only 10 players are initially selected for the match.
|
6835
7154
|
#
|
6836
7155
|
# @option params [String] :custom_event_data
|
6837
7156
|
# Information to add to all events related to the matchmaking
|
6838
7157
|
# configuration.
|
6839
7158
|
#
|
6840
7159
|
# @option params [Array<Types::GameProperty>] :game_properties
|
6841
|
-
#
|
7160
|
+
# A set of custom properties for a game session, formatted as key-value
|
6842
7161
|
# pairs. These properties are passed to a game server process in the
|
6843
7162
|
# GameSession object with a request to start a new game session (see
|
6844
7163
|
# [Start a Game Session][1]). This information is added to the new
|
@@ -6849,7 +7168,7 @@ module Aws::GameLift
|
|
6849
7168
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
6850
7169
|
#
|
6851
7170
|
# @option params [String] :game_session_data
|
6852
|
-
#
|
7171
|
+
# A set of custom game session properties, formatted as a single string
|
6853
7172
|
# value. This data is passed to a game server process in the GameSession
|
6854
7173
|
# object with a request to start a new game session (see [Start a Game
|
6855
7174
|
# Session][1]). This information is added to the new GameSession object
|
@@ -6860,12 +7179,13 @@ module Aws::GameLift
|
|
6860
7179
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
6861
7180
|
#
|
6862
7181
|
# @option params [String] :backfill_mode
|
6863
|
-
#
|
6864
|
-
# configuration. Specify MANUAL when your game manages
|
6865
|
-
# manually or does not use the match backfill feature.
|
6866
|
-
# to have GameLift create a StartMatchBackfill request
|
6867
|
-
# session has one or more open slots. Learn more about
|
6868
|
-
# automatic backfill in [Backfill Existing Games with
|
7182
|
+
# The method that is used to backfill game sessions created with this
|
7183
|
+
# matchmaking configuration. Specify MANUAL when your game manages
|
7184
|
+
# backfill requests manually or does not use the match backfill feature.
|
7185
|
+
# Specify AUTOMATIC to have GameLift create a StartMatchBackfill request
|
7186
|
+
# whenever a game session has one or more open slots. Learn more about
|
7187
|
+
# manual and automatic backfill in [Backfill Existing Games with
|
7188
|
+
# FlexMatch][1].
|
6869
7189
|
#
|
6870
7190
|
#
|
6871
7191
|
#
|
@@ -6878,13 +7198,13 @@ module Aws::GameLift
|
|
6878
7198
|
# @example Request syntax with placeholder values
|
6879
7199
|
#
|
6880
7200
|
# resp = client.update_matchmaking_configuration({
|
6881
|
-
# name: "
|
7201
|
+
# name: "MatchmakingConfigurationName", # required
|
6882
7202
|
# description: "NonZeroAndMaxString",
|
6883
7203
|
# game_session_queue_arns: ["ArnStringModel"],
|
6884
7204
|
# request_timeout_seconds: 1,
|
6885
7205
|
# acceptance_timeout_seconds: 1,
|
6886
7206
|
# acceptance_required: false,
|
6887
|
-
# rule_set_name: "
|
7207
|
+
# rule_set_name: "MatchmakingRuleSetName",
|
6888
7208
|
# notification_target: "SnsArnStringModel",
|
6889
7209
|
# additional_player_count: 1,
|
6890
7210
|
# custom_event_data: "CustomEventData",
|
@@ -6901,6 +7221,7 @@ module Aws::GameLift
|
|
6901
7221
|
# @example Response structure
|
6902
7222
|
#
|
6903
7223
|
# resp.configuration.name #=> String
|
7224
|
+
# resp.configuration.configuration_arn #=> String
|
6904
7225
|
# resp.configuration.description #=> String
|
6905
7226
|
# resp.configuration.game_session_queue_arns #=> Array
|
6906
7227
|
# resp.configuration.game_session_queue_arns[0] #=> String
|
@@ -6908,6 +7229,7 @@ module Aws::GameLift
|
|
6908
7229
|
# resp.configuration.acceptance_timeout_seconds #=> Integer
|
6909
7230
|
# resp.configuration.acceptance_required #=> Boolean
|
6910
7231
|
# resp.configuration.rule_set_name #=> String
|
7232
|
+
# resp.configuration.rule_set_arn #=> String
|
6911
7233
|
# resp.configuration.notification_target #=> String
|
6912
7234
|
# resp.configuration.additional_player_count #=> Integer
|
6913
7235
|
# resp.configuration.custom_event_data #=> String
|
@@ -6927,20 +7249,20 @@ module Aws::GameLift
|
|
6927
7249
|
req.send_request(options)
|
6928
7250
|
end
|
6929
7251
|
|
6930
|
-
# Updates the current
|
7252
|
+
# Updates the current runtime configuration for the specified fleet,
|
6931
7253
|
# which tells Amazon GameLift how to launch server processes on
|
6932
|
-
# instances in the fleet. You can update a fleet's
|
7254
|
+
# instances in the fleet. You can update a fleet's runtime
|
6933
7255
|
# configuration at any time after the fleet is created; it does not need
|
6934
7256
|
# to be in an `ACTIVE` status.
|
6935
7257
|
#
|
6936
|
-
# To update
|
7258
|
+
# To update runtime configuration, specify the fleet ID and provide a
|
6937
7259
|
# `RuntimeConfiguration` object with an updated set of server process
|
6938
7260
|
# configurations.
|
6939
7261
|
#
|
6940
7262
|
# Each instance in a Amazon GameLift fleet checks regularly for an
|
6941
|
-
# updated
|
7263
|
+
# updated runtime configuration and changes how it launches server
|
6942
7264
|
# processes to comply with the latest version. Existing server processes
|
6943
|
-
# are not affected by the update;
|
7265
|
+
# are not affected by the update; runtime configuration changes are
|
6944
7266
|
# applied gradually as existing processes shut down and new processes
|
6945
7267
|
# are launched during Amazon GameLift's normal process recycling
|
6946
7268
|
# activity.
|
@@ -6957,21 +7279,7 @@ module Aws::GameLift
|
|
6957
7279
|
#
|
6958
7280
|
# * DeleteFleet
|
6959
7281
|
#
|
6960
|
-
# *
|
6961
|
-
#
|
6962
|
-
# * DescribeFleetAttributes
|
6963
|
-
#
|
6964
|
-
# * DescribeFleetCapacity
|
6965
|
-
#
|
6966
|
-
# * DescribeFleetPortSettings
|
6967
|
-
#
|
6968
|
-
# * DescribeFleetUtilization
|
6969
|
-
#
|
6970
|
-
# * DescribeRuntimeConfiguration
|
6971
|
-
#
|
6972
|
-
# * DescribeEC2InstanceLimits
|
6973
|
-
#
|
6974
|
-
# * DescribeFleetEvents
|
7282
|
+
# * DescribeFleetAttributes
|
6975
7283
|
#
|
6976
7284
|
# * Update fleets:
|
6977
7285
|
#
|
@@ -6994,16 +7302,17 @@ module Aws::GameLift
|
|
6994
7302
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
6995
7303
|
#
|
6996
7304
|
# @option params [required, String] :fleet_id
|
6997
|
-
#
|
7305
|
+
# A unique identifier for a fleet to update runtime configuration for.
|
7306
|
+
# You can use either the fleet ID or ARN value.
|
6998
7307
|
#
|
6999
7308
|
# @option params [required, Types::RuntimeConfiguration] :runtime_configuration
|
7000
7309
|
# Instructions for launching server processes on each instance in the
|
7001
7310
|
# fleet. Server processes run either a custom game build executable or a
|
7002
|
-
# Realtime Servers script. The
|
7311
|
+
# Realtime Servers script. The runtime configuration lists the types of
|
7003
7312
|
# server processes to run on an instance and includes the following
|
7004
7313
|
# configuration settings: the server executable or launch script file,
|
7005
7314
|
# launch parameters, and the number of processes to run concurrently on
|
7006
|
-
# each instance. A CreateFleet request must include a
|
7315
|
+
# each instance. A CreateFleet request must include a runtime
|
7007
7316
|
# configuration with at least one server process configuration.
|
7008
7317
|
#
|
7009
7318
|
# @return [Types::UpdateRuntimeConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7081,30 +7390,31 @@ module Aws::GameLift
|
|
7081
7390
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html
|
7082
7391
|
#
|
7083
7392
|
# @option params [required, String] :script_id
|
7084
|
-
#
|
7393
|
+
# A unique identifier for a Realtime script to update. You can use
|
7394
|
+
# either the script ID or ARN value.
|
7085
7395
|
#
|
7086
7396
|
# @option params [String] :name
|
7087
|
-
#
|
7397
|
+
# A descriptive label that is associated with a script. Script names do
|
7088
7398
|
# not need to be unique.
|
7089
7399
|
#
|
7090
7400
|
# @option params [String] :version
|
7091
|
-
#
|
7092
|
-
# not need to be unique.
|
7401
|
+
# The version that is associated with a build or script. Version strings
|
7402
|
+
# do not need to be unique.
|
7093
7403
|
#
|
7094
7404
|
# @option params [Types::S3Location] :storage_location
|
7095
|
-
#
|
7096
|
-
# Realtime scripts is stored. The storage location must specify the
|
7405
|
+
# The location of the Amazon S3 bucket where a zipped file containing
|
7406
|
+
# your Realtime scripts is stored. The storage location must specify the
|
7097
7407
|
# Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
|
7098
7408
|
# that allows Amazon GameLift to access the Amazon S3 storage location.
|
7099
|
-
# The S3 bucket must be in the same
|
7409
|
+
# The S3 bucket must be in the same Region where you want to create a
|
7100
7410
|
# new script. By default, Amazon GameLift uploads the latest version of
|
7101
7411
|
# the zip file; if you have S3 object versioning turned on, you can use
|
7102
7412
|
# the `ObjectVersion` parameter to specify an earlier version.
|
7103
7413
|
#
|
7104
7414
|
# @option params [String, IO] :zip_file
|
7105
|
-
#
|
7106
|
-
# file. The zip file can have one or multiple files. Maximum size of
|
7107
|
-
# zip file is 5 MB.
|
7415
|
+
# A data object containing your Realtime scripts and dependencies as a
|
7416
|
+
# zip file. The zip file can have one or multiple files. Maximum size of
|
7417
|
+
# a zip file is 5 MB.
|
7108
7418
|
#
|
7109
7419
|
# When using the AWS CLI tool to create a script, this parameter is set
|
7110
7420
|
# to the zip file name. It must be prepended with the string
|
@@ -7133,6 +7443,7 @@ module Aws::GameLift
|
|
7133
7443
|
# @example Response structure
|
7134
7444
|
#
|
7135
7445
|
# resp.script.script_id #=> String
|
7446
|
+
# resp.script.script_arn #=> String
|
7136
7447
|
# resp.script.name #=> String
|
7137
7448
|
# resp.script.version #=> String
|
7138
7449
|
# resp.script.size_on_disk #=> Integer
|
@@ -7185,7 +7496,7 @@ module Aws::GameLift
|
|
7185
7496
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
|
7186
7497
|
#
|
7187
7498
|
# @option params [required, String] :rule_set_body
|
7188
|
-
#
|
7499
|
+
# A collection of matchmaking rules to validate, formatted as a JSON
|
7189
7500
|
# string.
|
7190
7501
|
#
|
7191
7502
|
# @return [Types::ValidateMatchmakingRuleSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7224,7 +7535,7 @@ module Aws::GameLift
|
|
7224
7535
|
params: params,
|
7225
7536
|
config: config)
|
7226
7537
|
context[:gem_name] = 'aws-sdk-gamelift'
|
7227
|
-
context[:gem_version] = '1.
|
7538
|
+
context[:gem_version] = '1.27.0'
|
7228
7539
|
Seahorse::Client::Request.new(handlers, context)
|
7229
7540
|
end
|
7230
7541
|
|