aws-sdk-gamelift 1.58.0 → 1.60.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +939 -1068
- data/lib/aws-sdk-gamelift/client_api.rb +291 -11
- data/lib/aws-sdk-gamelift/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-gamelift/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-gamelift/endpoints.rb +1471 -0
- data/lib/aws-sdk-gamelift/plugins/endpoints.rb +276 -0
- data/lib/aws-sdk-gamelift/types.rb +1006 -2124
- data/lib/aws-sdk-gamelift.rb +5 -1
- metadata +8 -4
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:gamelift)
|
@@ -79,8 +79,9 @@ module Aws::GameLift
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
84
|
+
add_plugin(Aws::GameLift::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -297,6 +298,19 @@ module Aws::GameLift
|
|
297
298
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
298
299
|
# requests are made, and retries are disabled.
|
299
300
|
#
|
301
|
+
# @option options [Aws::TokenProvider] :token_provider
|
302
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
303
|
+
# following classes:
|
304
|
+
#
|
305
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
306
|
+
# tokens.
|
307
|
+
#
|
308
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
309
|
+
# access token generated from `aws login`.
|
310
|
+
#
|
311
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
312
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
313
|
+
#
|
300
314
|
# @option options [Boolean] :use_dualstack_endpoint
|
301
315
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
302
316
|
# will be used if available.
|
@@ -310,6 +324,9 @@ module Aws::GameLift
|
|
310
324
|
# When `true`, request parameters are validated before
|
311
325
|
# sending the request.
|
312
326
|
#
|
327
|
+
# @option options [Aws::GameLift::EndpointProvider] :endpoint_provider
|
328
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::GameLift::EndpointParameters`
|
329
|
+
#
|
313
330
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
314
331
|
# requests through. Formatted like 'http://proxy.com:123'.
|
315
332
|
#
|
@@ -393,16 +410,10 @@ module Aws::GameLift
|
|
393
410
|
#
|
394
411
|
# [ FlexMatch events][2] (reference)
|
395
412
|
#
|
396
|
-
# **Related actions**
|
397
|
-
#
|
398
|
-
# StartMatchmaking \| DescribeMatchmaking \| StopMatchmaking \|
|
399
|
-
# AcceptMatch \| StartMatchBackfill \| [All APIs by task][3]
|
400
|
-
#
|
401
413
|
#
|
402
414
|
#
|
403
415
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
404
416
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html
|
405
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
406
417
|
#
|
407
418
|
# @option params [required, String] :ticket_id
|
408
419
|
# A unique identifier for a matchmaking ticket. The ticket must be in
|
@@ -455,11 +466,10 @@ module Aws::GameLift
|
|
455
466
|
# returned. A claimed game server's utilization status remains
|
456
467
|
# `AVAILABLE` while the claim status is set to `CLAIMED` for up to 60
|
457
468
|
# seconds. This time period gives the game server time to update its
|
458
|
-
# status to `UTILIZED`
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
# configurable.
|
469
|
+
# status to `UTILIZED` after players join. If the game server's status
|
470
|
+
# is not updated within 60 seconds, the game server reverts to unclaimed
|
471
|
+
# status and is available to be claimed by another request. The claim
|
472
|
+
# time period is a fixed value and is not configurable.
|
463
473
|
#
|
464
474
|
# If you try to claim a specific game server, this request will fail in
|
465
475
|
# the following cases:
|
@@ -471,30 +481,24 @@ module Aws::GameLift
|
|
471
481
|
# <note markdown="1"> When claiming a specific game server, this request will succeed even
|
472
482
|
# if the game server is running on an instance in `DRAINING` status. To
|
473
483
|
# avoid this, first check the instance status by calling
|
474
|
-
# DescribeGameServerInstances.
|
484
|
+
# [DescribeGameServerInstances][1] .
|
475
485
|
#
|
476
486
|
# </note>
|
477
487
|
#
|
478
488
|
# **Learn more**
|
479
489
|
#
|
480
|
-
# [GameLift FleetIQ Guide][
|
481
|
-
#
|
482
|
-
# **Related actions**
|
483
|
-
#
|
484
|
-
# RegisterGameServer \| ListGameServers \| ClaimGameServer \|
|
485
|
-
# DescribeGameServer \| UpdateGameServer \| DeregisterGameServer \| [All
|
486
|
-
# APIs by task][2]
|
490
|
+
# [GameLift FleetIQ Guide][2]
|
487
491
|
#
|
488
492
|
#
|
489
493
|
#
|
490
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
491
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/
|
494
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameServerInstances.html
|
495
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
492
496
|
#
|
493
497
|
# @option params [required, String] :game_server_group_name
|
494
498
|
# A unique identifier for the game server group where the game server is
|
495
|
-
# running.
|
496
|
-
#
|
497
|
-
#
|
499
|
+
# running. If you are not specifying a game server to claim, this value
|
500
|
+
# identifies where you want GameLift FleetIQ to look for an available
|
501
|
+
# game server to claim.
|
498
502
|
#
|
499
503
|
# @option params [String] :game_server_id
|
500
504
|
# A custom string that uniquely identifies the game server to claim. If
|
@@ -504,8 +508,7 @@ module Aws::GameLift
|
|
504
508
|
# @option params [String] :game_server_data
|
505
509
|
# A set of custom game server properties, formatted as a single string
|
506
510
|
# value. This data is passed to a game client or service when it
|
507
|
-
# requests information on game servers
|
508
|
-
# ClaimGameServer.
|
511
|
+
# requests information on game servers.
|
509
512
|
#
|
510
513
|
# @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
511
514
|
#
|
@@ -562,8 +565,7 @@ module Aws::GameLift
|
|
562
565
|
#
|
563
566
|
# **Related actions**
|
564
567
|
#
|
565
|
-
#
|
566
|
-
# DeleteAlias \| ResolveAlias \| [All APIs by task][1]
|
568
|
+
# [All APIs by task][1]
|
567
569
|
#
|
568
570
|
#
|
569
571
|
#
|
@@ -586,10 +588,6 @@ module Aws::GameLift
|
|
586
588
|
# resources are useful for resource management, access management and
|
587
589
|
# cost allocation. For more information, see [ Tagging Amazon Web
|
588
590
|
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
589
|
-
# Once the resource is created, you can use TagResource, UntagResource,
|
590
|
-
# and ListTagsForResource to add, remove, and view tags. The maximum tag
|
591
|
-
# limit may be lower than stated. See the Amazon Web Services General
|
592
|
-
# Reference for actual tagging limits.
|
593
591
|
#
|
594
592
|
#
|
595
593
|
#
|
@@ -639,34 +637,32 @@ module Aws::GameLift
|
|
639
637
|
end
|
640
638
|
|
641
639
|
# Creates a new Amazon GameLift build resource for your game server
|
642
|
-
# binary files.
|
643
|
-
#
|
640
|
+
# binary files. Combine game server binaries into a zip file for use
|
641
|
+
# with Amazon GameLift.
|
644
642
|
#
|
645
643
|
# When setting up a new game build for GameLift, we recommend using the
|
646
|
-
#
|
644
|
+
# CLI command <b> <a
|
647
645
|
# href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
648
646
|
# </b>. This helper command combines two tasks: (1) it uploads your
|
649
647
|
# build files from a file directory to a GameLift Amazon S3 location,
|
650
648
|
# and (2) it creates a new build resource.
|
651
649
|
#
|
652
|
-
#
|
650
|
+
# You can use the operation in the following scenarios:
|
653
651
|
#
|
654
652
|
# * To create a new game build with build files that are in an Amazon S3
|
655
653
|
# location under an Amazon Web Services account that you control. To
|
656
|
-
# use this option, you
|
657
|
-
#
|
658
|
-
#
|
659
|
-
# location of your game build.
|
654
|
+
# use this option, you give Amazon GameLift access to the Amazon S3
|
655
|
+
# bucket. With permissions in place, specify a build name, operating
|
656
|
+
# system, and the Amazon S3 storage location of your game build.
|
660
657
|
#
|
661
658
|
# * To directly upload your build files to a GameLift Amazon S3
|
662
|
-
# location. To use this option,
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
# location once only; that can't be updated.
|
659
|
+
# location. To use this option, specify a build name and operating
|
660
|
+
# system. This operation creates a new build resource and also returns
|
661
|
+
# an Amazon S3 location with temporary access credentials. Use the
|
662
|
+
# credentials to manually upload your build files to the specified
|
663
|
+
# Amazon S3 location. For more information, see [Uploading Objects][1]
|
664
|
+
# in the *Amazon S3 Developer Guide*. After you upload build files to
|
665
|
+
# the GameLift Amazon S3 location, you can't update them.
|
670
666
|
#
|
671
667
|
# If successful, this operation creates a new build resource with a
|
672
668
|
# unique build ID and places it in `INITIALIZED` status. A build must be
|
@@ -678,10 +674,7 @@ module Aws::GameLift
|
|
678
674
|
#
|
679
675
|
# [ Create a Build with Files in Amazon S3][3]
|
680
676
|
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
# CreateBuild \| ListBuilds \| DescribeBuild \| UpdateBuild \|
|
684
|
-
# DeleteBuild \| [All APIs by task][4]
|
677
|
+
# [All APIs by task][4]
|
685
678
|
#
|
686
679
|
#
|
687
680
|
#
|
@@ -691,14 +684,12 @@ module Aws::GameLift
|
|
691
684
|
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
692
685
|
#
|
693
686
|
# @option params [String] :name
|
694
|
-
# A descriptive label
|
695
|
-
#
|
696
|
-
# later.
|
687
|
+
# A descriptive label associated with a build. Build names do not need
|
688
|
+
# to be unique. You can change this value later.
|
697
689
|
#
|
698
690
|
# @option params [String] :version
|
699
|
-
# Version information
|
700
|
-
#
|
701
|
-
# this value later.
|
691
|
+
# Version information associated with a build or script. Version strings
|
692
|
+
# do not need to be unique. You can change this value later.
|
702
693
|
#
|
703
694
|
# @option params [Types::S3Location] :storage_location
|
704
695
|
# Information indicating where your game build files are stored. Use
|
@@ -713,27 +704,39 @@ module Aws::GameLift
|
|
713
704
|
# `SizeOnDisk` of 0.
|
714
705
|
#
|
715
706
|
# @option params [String] :operating_system
|
716
|
-
# The operating system that the game server binaries
|
707
|
+
# The operating system that you built the game server binaries to run
|
717
708
|
# on. This value determines the type of fleet resources that you can use
|
718
709
|
# for this build. If your game build contains multiple executables, they
|
719
710
|
# all must run on the same operating system. If an operating system is
|
720
|
-
# not specified when creating a build,
|
721
|
-
#
|
711
|
+
# not specified when creating a build, GameLift uses the default value
|
712
|
+
# (WINDOWS\_2012). This value cannot be changed later.
|
722
713
|
#
|
723
714
|
# @option params [Array<Types::Tag>] :tags
|
724
715
|
# A list of labels to assign to the new build resource. Tags are
|
725
|
-
# developer
|
716
|
+
# developer defined key-value pairs. Tagging Amazon Web Services
|
726
717
|
# resources are useful for resource management, access management and
|
727
718
|
# cost allocation. For more information, see [ Tagging Amazon Web
|
728
719
|
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
729
|
-
# Once the resource is created, you can use TagResource,
|
730
|
-
# and ListTagsForResource to add, remove, and
|
731
|
-
# limit may be lower than stated. See the
|
732
|
-
# Reference for actual tagging limits.
|
720
|
+
# Once the resource is created, you can use [TagResource][2],
|
721
|
+
# [UntagResource][3], and [ListTagsForResource][4] to add, remove, and
|
722
|
+
# view tags. The maximum tag limit may be lower than stated. See the
|
723
|
+
# Amazon Web Services General Reference for actual tagging limits.
|
733
724
|
#
|
734
725
|
#
|
735
726
|
#
|
736
727
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
728
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html
|
729
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html
|
730
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html
|
731
|
+
#
|
732
|
+
# @option params [String] :server_sdk_version
|
733
|
+
# A server SDK version you used when integrating your game server build
|
734
|
+
# with GameLift. For more information see [Integrate games with custom
|
735
|
+
# game servers][1].
|
736
|
+
#
|
737
|
+
#
|
738
|
+
#
|
739
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html
|
737
740
|
#
|
738
741
|
# @return [Types::CreateBuildOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
739
742
|
#
|
@@ -759,6 +762,7 @@ module Aws::GameLift
|
|
759
762
|
# value: "TagValue", # required
|
760
763
|
# },
|
761
764
|
# ],
|
765
|
+
# server_sdk_version: "ServerSdkVersion",
|
762
766
|
# })
|
763
767
|
#
|
764
768
|
# @example Response structure
|
@@ -771,6 +775,7 @@ module Aws::GameLift
|
|
771
775
|
# resp.build.size_on_disk #=> Integer
|
772
776
|
# resp.build.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
773
777
|
# resp.build.creation_time #=> Time
|
778
|
+
# resp.build.server_sdk_version #=> String
|
774
779
|
# resp.upload_credentials.access_key_id #=> String
|
775
780
|
# resp.upload_credentials.secret_access_key #=> String
|
776
781
|
# resp.upload_credentials.session_token #=> String
|
@@ -822,14 +827,7 @@ module Aws::GameLift
|
|
822
827
|
#
|
823
828
|
# If successful, this operation creates a new Fleet resource and places
|
824
829
|
# it in `NEW` status, which prompts GameLift to initiate the [fleet
|
825
|
-
# creation workflow][1].
|
826
|
-
# status using DescribeFleetAttributes and
|
827
|
-
# DescribeFleetLocationAttributes/, or by monitoring fleet creation
|
828
|
-
# events using DescribeFleetEvents. As soon as the fleet status changes
|
829
|
-
# to `ACTIVE`, you can enable automatic scaling for the fleet with
|
830
|
-
# PutScalingPolicy and set capacity for the home Region with
|
831
|
-
# UpdateFleetCapacity. When the status of each remote location reaches
|
832
|
-
# `ACTIVE`, you can set capacity by location using UpdateFleetCapacity.
|
830
|
+
# creation workflow][1].
|
833
831
|
#
|
834
832
|
# **Learn more**
|
835
833
|
#
|
@@ -839,26 +837,18 @@ module Aws::GameLift
|
|
839
837
|
#
|
840
838
|
# [Multi-location fleets][2]
|
841
839
|
#
|
842
|
-
# **Related actions**
|
843
|
-
#
|
844
|
-
# CreateFleet \| UpdateFleetCapacity \| PutScalingPolicy \|
|
845
|
-
# DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
846
|
-
# DescribeFleetLocationAttributes \| UpdateFleetAttributes \|
|
847
|
-
# StopFleetActions \| DeleteFleet \| [All APIs by task][4]
|
848
|
-
#
|
849
840
|
#
|
850
841
|
#
|
851
842
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html
|
852
843
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
853
844
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation
|
854
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
855
845
|
#
|
856
846
|
# @option params [required, String] :name
|
857
847
|
# A descriptive label that is associated with a fleet. Fleet names do
|
858
848
|
# not need to be unique.
|
859
849
|
#
|
860
850
|
# @option params [String] :description
|
861
|
-
# A
|
851
|
+
# A description for the fleet.
|
862
852
|
#
|
863
853
|
# @option params [String] :build_id
|
864
854
|
# The unique identifier for a custom game server build to be deployed on
|
@@ -886,14 +876,14 @@ module Aws::GameLift
|
|
886
876
|
# **This parameter is no longer used.** To specify where GameLift should
|
887
877
|
# store log files once a server process shuts down, use the GameLift
|
888
878
|
# server API `ProcessReady()` and specify one or more directory paths in
|
889
|
-
# `logParameters`.
|
890
|
-
#
|
879
|
+
# `logParameters`. For more information, see [Initialize the server
|
880
|
+
# process][1] in the *GameLift Developer Guide*.
|
891
881
|
#
|
892
882
|
#
|
893
883
|
#
|
894
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api
|
884
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize
|
895
885
|
#
|
896
|
-
# @option params [
|
886
|
+
# @option params [String] :ec2_instance_type
|
897
887
|
# The GameLift-supported Amazon EC2 instance type to use for all fleet
|
898
888
|
# instances. Instance type determines the computing resources that will
|
899
889
|
# be used to host your game servers, including CPU, memory, storage, and
|
@@ -915,7 +905,8 @@ module Aws::GameLift
|
|
915
905
|
# The status of termination protection for active game sessions on the
|
916
906
|
# fleet. By default, this property is set to `NoProtection`. You can
|
917
907
|
# also set game session protection for an individual game session by
|
918
|
-
# calling
|
908
|
+
# calling
|
909
|
+
# [UpdateGameSession](gamelift/latest/apireference/API_UpdateGameSession.html).
|
919
910
|
#
|
920
911
|
# * **NoProtection** - Game sessions can be terminated during active
|
921
912
|
# gameplay as a result of a scale-down event.
|
@@ -994,17 +985,29 @@ module Aws::GameLift
|
|
994
985
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
995
986
|
#
|
996
987
|
# @option params [Types::CertificateConfiguration] :certificate_configuration
|
997
|
-
# Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
998
|
-
#
|
999
|
-
# the game servers
|
1000
|
-
# `CertificateConfiguration` is
|
1001
|
-
#
|
1002
|
-
#
|
1003
|
-
#
|
1004
|
-
#
|
1005
|
-
#
|
1006
|
-
#
|
1007
|
-
#
|
988
|
+
# Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
989
|
+
# GameLift uses the certificates to encrypt traffic between game clients
|
990
|
+
# and the game servers running on GameLift. By default, the
|
991
|
+
# `CertificateConfiguration` is `DISABLED`. You can't change this
|
992
|
+
# property after you create the fleet.
|
993
|
+
#
|
994
|
+
# Certificate Manager (ACM) certificates expire after 13 months.
|
995
|
+
# Certificate expiration can cause fleets to fail, preventing players
|
996
|
+
# from connecting to instances in the fleet. We recommend you replace
|
997
|
+
# fleets before 13 months, consider using fleet aliases for a smooth
|
998
|
+
# transition.
|
999
|
+
#
|
1000
|
+
# <note markdown="1"> ACM isn't available in all Amazon Web Services regions. A fleet
|
1001
|
+
# creation request with certificate generation enabled in an unsupported
|
1002
|
+
# Region, fails with a 4xx error. For more information about the
|
1003
|
+
# supported Regions, see [Supported Regions][1] in the *Certificate
|
1004
|
+
# Manager User Guide*.
|
1005
|
+
#
|
1006
|
+
# </note>
|
1007
|
+
#
|
1008
|
+
#
|
1009
|
+
#
|
1010
|
+
# [1]: https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html
|
1008
1011
|
#
|
1009
1012
|
# @option params [Array<Types::LocationConfiguration>] :locations
|
1010
1013
|
# A set of remote locations to deploy additional instances to and manage
|
@@ -1021,15 +1024,19 @@ module Aws::GameLift
|
|
1021
1024
|
# resources are useful for resource management, access management and
|
1022
1025
|
# cost allocation. For more information, see [ Tagging Amazon Web
|
1023
1026
|
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
1024
|
-
# Once the fleet is created, you can use TagResource, UntagResource, and
|
1025
|
-
# ListTagsForResource to add, remove, and view tags. The maximum tag
|
1026
|
-
# limit may be lower than stated. See the *Amazon Web Services General
|
1027
|
-
# Reference* for actual tagging limits.
|
1028
1027
|
#
|
1029
1028
|
#
|
1030
1029
|
#
|
1031
1030
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1032
1031
|
#
|
1032
|
+
# @option params [String] :compute_type
|
1033
|
+
# The type of compute resource used to host your game servers. You can
|
1034
|
+
# use your own compute resources with GameLift Anywhere or use Amazon
|
1035
|
+
# EC2 instances with managed GameLift.
|
1036
|
+
#
|
1037
|
+
# @option params [Types::AnywhereConfiguration] :anywhere_configuration
|
1038
|
+
# GameLift Anywhere configuration options.
|
1039
|
+
#
|
1033
1040
|
# @return [Types::CreateFleetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1034
1041
|
#
|
1035
1042
|
# * {Types::CreateFleetOutput#fleet_attributes #fleet_attributes} => Types::FleetAttributes
|
@@ -1045,7 +1052,7 @@ module Aws::GameLift
|
|
1045
1052
|
# server_launch_path: "LaunchPathStringModel",
|
1046
1053
|
# server_launch_parameters: "LaunchParametersStringModel",
|
1047
1054
|
# log_paths: ["NonZeroAndMaxString"],
|
1048
|
-
# ec2_instance_type: "t2.micro", #
|
1055
|
+
# ec2_instance_type: "t2.micro", # accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge
|
1049
1056
|
# ec2_inbound_permissions: [
|
1050
1057
|
# {
|
1051
1058
|
# from_port: 1, # required
|
@@ -1080,7 +1087,7 @@ module Aws::GameLift
|
|
1080
1087
|
# },
|
1081
1088
|
# locations: [
|
1082
1089
|
# {
|
1083
|
-
# location: "LocationStringModel",
|
1090
|
+
# location: "LocationStringModel", # required
|
1084
1091
|
# },
|
1085
1092
|
# ],
|
1086
1093
|
# tags: [
|
@@ -1089,6 +1096,10 @@ module Aws::GameLift
|
|
1089
1096
|
# value: "TagValue", # required
|
1090
1097
|
# },
|
1091
1098
|
# ],
|
1099
|
+
# compute_type: "EC2", # accepts EC2, ANYWHERE
|
1100
|
+
# anywhere_configuration: {
|
1101
|
+
# cost: "NonNegativeLimitedLengthDouble", # required
|
1102
|
+
# },
|
1092
1103
|
# })
|
1093
1104
|
#
|
1094
1105
|
# @example Response structure
|
@@ -1101,7 +1112,7 @@ module Aws::GameLift
|
|
1101
1112
|
# resp.fleet_attributes.name #=> String
|
1102
1113
|
# resp.fleet_attributes.creation_time #=> Time
|
1103
1114
|
# resp.fleet_attributes.termination_time #=> Time
|
1104
|
-
# resp.fleet_attributes.status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
1115
|
+
# resp.fleet_attributes.status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
1105
1116
|
# resp.fleet_attributes.build_id #=> String
|
1106
1117
|
# resp.fleet_attributes.build_arn #=> String
|
1107
1118
|
# resp.fleet_attributes.script_id #=> String
|
@@ -1120,9 +1131,11 @@ module Aws::GameLift
|
|
1120
1131
|
# resp.fleet_attributes.stopped_actions[0] #=> String, one of "AUTO_SCALING"
|
1121
1132
|
# resp.fleet_attributes.instance_role_arn #=> String
|
1122
1133
|
# resp.fleet_attributes.certificate_configuration.certificate_type #=> String, one of "DISABLED", "GENERATED"
|
1134
|
+
# resp.fleet_attributes.compute_type #=> String, one of "EC2", "ANYWHERE"
|
1135
|
+
# resp.fleet_attributes.anywhere_configuration.cost #=> String
|
1123
1136
|
# resp.location_states #=> Array
|
1124
1137
|
# resp.location_states[0].location #=> String
|
1125
|
-
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
1138
|
+
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
1126
1139
|
#
|
1127
1140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleet AWS API Documentation
|
1128
1141
|
#
|
@@ -1140,9 +1153,8 @@ module Aws::GameLift
|
|
1140
1153
|
#
|
1141
1154
|
# <note markdown="1"> This operation cannot be used with fleets that don't support remote
|
1142
1155
|
# locations. Fleets can have multiple locations only if they reside in
|
1143
|
-
# Amazon Web Services Regions that support this feature
|
1144
|
-
#
|
1145
|
-
# in March 2021.
|
1156
|
+
# Amazon Web Services Regions that support this feature and were created
|
1157
|
+
# after the feature was released in March 2021.
|
1146
1158
|
#
|
1147
1159
|
# </note>
|
1148
1160
|
#
|
@@ -1153,29 +1165,18 @@ module Aws::GameLift
|
|
1153
1165
|
# their status set to `NEW`. GameLift initiates the process of starting
|
1154
1166
|
# an instance in each added location. You can track the status of each
|
1155
1167
|
# new location by monitoring location creation events using
|
1156
|
-
# DescribeFleetEvents.
|
1157
|
-
# calling DescribeFleetLocationAttributes. After a location status
|
1158
|
-
# becomes `ACTIVE`, you can adjust the location's capacity as needed
|
1159
|
-
# with UpdateFleetCapacity.
|
1168
|
+
# [DescribeFleetEvents][1].
|
1160
1169
|
#
|
1161
1170
|
# **Learn more**
|
1162
1171
|
#
|
1163
|
-
# [Setting up fleets][
|
1164
|
-
#
|
1165
|
-
# [Multi-location fleets][1]
|
1166
|
-
#
|
1167
|
-
# **Related actions**
|
1172
|
+
# [Setting up fleets][2]
|
1168
1173
|
#
|
1169
|
-
#
|
1170
|
-
# DescribeFleetLocationCapacity \| DescribeFleetLocationUtilization \|
|
1171
|
-
# DescribeFleetAttributes \| DescribeFleetCapacity \|
|
1172
|
-
# DescribeFleetUtilization \| UpdateFleetCapacity \| StopFleetActions \|
|
1173
|
-
# DeleteFleetLocations \| [All APIs by task][2]
|
1174
|
+
# [Multi-location fleets][2]
|
1174
1175
|
#
|
1175
1176
|
#
|
1176
1177
|
#
|
1177
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
1178
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
1178
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html
|
1179
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
1179
1180
|
#
|
1180
1181
|
# @option params [required, String] :fleet_id
|
1181
1182
|
# A unique identifier for the fleet to add locations to. You can use
|
@@ -1199,7 +1200,7 @@ module Aws::GameLift
|
|
1199
1200
|
# fleet_id: "FleetIdOrArn", # required
|
1200
1201
|
# locations: [ # required
|
1201
1202
|
# {
|
1202
|
-
# location: "LocationStringModel",
|
1203
|
+
# location: "LocationStringModel", # required
|
1203
1204
|
# },
|
1204
1205
|
# ],
|
1205
1206
|
# })
|
@@ -1210,7 +1211,7 @@ module Aws::GameLift
|
|
1210
1211
|
# resp.fleet_arn #=> String
|
1211
1212
|
# resp.location_states #=> Array
|
1212
1213
|
# resp.location_states[0].location #=> String
|
1213
|
-
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
1214
|
+
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
1214
1215
|
#
|
1215
1216
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateFleetLocations AWS API Documentation
|
1216
1217
|
#
|
@@ -1266,20 +1267,11 @@ module Aws::GameLift
|
|
1266
1267
|
#
|
1267
1268
|
# [GameLift FleetIQ Guide][3]
|
1268
1269
|
#
|
1269
|
-
# **Related actions**
|
1270
|
-
#
|
1271
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
1272
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
1273
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
1274
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
1275
|
-
# task][4]
|
1276
|
-
#
|
1277
1270
|
#
|
1278
1271
|
#
|
1279
1272
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
|
1280
1273
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html
|
1281
1274
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
1282
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
1283
1275
|
#
|
1284
1276
|
# @option params [required, String] :game_server_group_name
|
1285
1277
|
# An identifier for the new game server group. This value is used to
|
@@ -1405,10 +1397,6 @@ module Aws::GameLift
|
|
1405
1397
|
# resources is useful for resource management, access management, and
|
1406
1398
|
# cost allocation. For more information, see [ Tagging Amazon Web
|
1407
1399
|
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
1408
|
-
# Once the resource is created, you can use TagResource, UntagResource,
|
1409
|
-
# and ListTagsForResource to add, remove, and view tags, respectively.
|
1410
|
-
# The maximum tag limit may be lower than stated. See the Amazon Web
|
1411
|
-
# Services General Reference for actual tagging limits.
|
1412
1400
|
#
|
1413
1401
|
#
|
1414
1402
|
#
|
@@ -1484,10 +1472,8 @@ module Aws::GameLift
|
|
1484
1472
|
# location. This operation prompts an available server process to start
|
1485
1473
|
# a game session and retrieves connection information for the new game
|
1486
1474
|
# session. As an alternative, consider using the GameLift game session
|
1487
|
-
# placement feature with
|
1488
|
-
#
|
1489
|
-
# with StartGameSessionPlacement, which uses FleetIQ algorithms and
|
1490
|
-
# queues to optimize the placement process.
|
1475
|
+
# placement feature with [StartGameSessionPlacement][1] , which uses
|
1476
|
+
# FleetIQ algorithms and queues to optimize the placement process.
|
1491
1477
|
#
|
1492
1478
|
# When creating a game session, you specify exactly where you want to
|
1493
1479
|
# place it and provide a set of game session configuration settings. The
|
@@ -1510,31 +1496,28 @@ module Aws::GameLift
|
|
1510
1496
|
# connection information is provided and player sessions can be created
|
1511
1497
|
# for the game session. By default, newly created game sessions are open
|
1512
1498
|
# to new players. You can restrict new player access by using
|
1513
|
-
# UpdateGameSession to change the game session's player session
|
1499
|
+
# [UpdateGameSession][2] to change the game session's player session
|
1514
1500
|
# creation policy.
|
1515
1501
|
#
|
1516
1502
|
# Game session logs are retained for all active game sessions for 14
|
1517
|
-
# days. To access the logs, call GetGameSessionLogUrl to download
|
1518
|
-
# log files.
|
1503
|
+
# days. To access the logs, call [GetGameSessionLogUrl][3] to download
|
1504
|
+
# the log files.
|
1519
1505
|
#
|
1520
1506
|
# *Available in Amazon GameLift Local.*
|
1521
1507
|
#
|
1522
1508
|
# **Learn more**
|
1523
1509
|
#
|
1524
|
-
# [Start a game session][
|
1525
|
-
#
|
1526
|
-
# **Related actions**
|
1510
|
+
# [Start a game session][4]
|
1527
1511
|
#
|
1528
|
-
#
|
1529
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
1530
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
1531
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
1532
|
-
# by task][2]
|
1512
|
+
# [All APIs by task][5]
|
1533
1513
|
#
|
1534
1514
|
#
|
1535
1515
|
#
|
1536
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
1537
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
1516
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html
|
1517
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html
|
1518
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html
|
1519
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1520
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
1538
1521
|
#
|
1539
1522
|
# @option params [String] :fleet_id
|
1540
1523
|
# A unique identifier for the fleet to create a game session in. You can
|
@@ -1556,9 +1539,8 @@ module Aws::GameLift
|
|
1556
1539
|
#
|
1557
1540
|
# @option params [Array<Types::GameProperty>] :game_properties
|
1558
1541
|
# A set of custom properties for a game session, formatted as key:value
|
1559
|
-
# pairs. These properties are passed to a game server process
|
1560
|
-
#
|
1561
|
-
# [Start a Game Session][1]).
|
1542
|
+
# pairs. These properties are passed to a game server process with a
|
1543
|
+
# request to start a new game session (see [Start a Game Session][1]).
|
1562
1544
|
#
|
1563
1545
|
#
|
1564
1546
|
#
|
@@ -1573,9 +1555,10 @@ module Aws::GameLift
|
|
1573
1555
|
# evaluate the new request against the policy.
|
1574
1556
|
#
|
1575
1557
|
# @option params [String] :game_session_id
|
1576
|
-
# *This parameter is
|
1577
|
-
#
|
1578
|
-
#
|
1558
|
+
# *This parameter is deprecated. Use `IdempotencyToken` instead.*
|
1559
|
+
#
|
1560
|
+
# Custom string that uniquely identifies a request for a new game
|
1561
|
+
# session. Maximum token length is 48 characters. If provided, this
|
1579
1562
|
# string is included in the new game session's ID.
|
1580
1563
|
#
|
1581
1564
|
# @option params [String] :idempotency_token
|
@@ -1593,9 +1576,8 @@ module Aws::GameLift
|
|
1593
1576
|
#
|
1594
1577
|
# @option params [String] :game_session_data
|
1595
1578
|
# A set of custom game session properties, formatted as a single string
|
1596
|
-
# value. This data is passed to a game server process
|
1597
|
-
#
|
1598
|
-
# Session][1]).
|
1579
|
+
# value. This data is passed to a game server process with a request to
|
1580
|
+
# start a new game session (see [Start a Game Session][1]).
|
1599
1581
|
#
|
1600
1582
|
#
|
1601
1583
|
#
|
@@ -1777,10 +1759,7 @@ module Aws::GameLift
|
|
1777
1759
|
# Services resources are useful for resource management, access
|
1778
1760
|
# management and cost allocation. For more information, see [ Tagging
|
1779
1761
|
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
1780
|
-
# Reference*.
|
1781
|
-
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
1782
|
-
# The maximum tag limit may be lower than stated. See the Amazon Web
|
1783
|
-
# Services General Reference for actual tagging limits.
|
1762
|
+
# Reference*.
|
1784
1763
|
#
|
1785
1764
|
#
|
1786
1765
|
#
|
@@ -1851,16 +1830,62 @@ module Aws::GameLift
|
|
1851
1830
|
req.send_request(options)
|
1852
1831
|
end
|
1853
1832
|
|
1833
|
+
# Creates a custom location for use in an Anywhere fleet.
|
1834
|
+
#
|
1835
|
+
# @option params [required, String] :location_name
|
1836
|
+
# A descriptive name for the custom location.
|
1837
|
+
#
|
1838
|
+
# @option params [Array<Types::Tag>] :tags
|
1839
|
+
# A list of labels to assign to the new matchmaking configuration
|
1840
|
+
# resource. Tags are developer-defined key-value pairs. Tagging Amazon
|
1841
|
+
# Web Services resources are useful for resource management, access
|
1842
|
+
# management and cost allocation. For more information, see [ Tagging
|
1843
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
1844
|
+
# Rareference*.
|
1845
|
+
#
|
1846
|
+
#
|
1847
|
+
#
|
1848
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1849
|
+
#
|
1850
|
+
# @return [Types::CreateLocationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1851
|
+
#
|
1852
|
+
# * {Types::CreateLocationOutput#location #location} => Types::LocationModel
|
1853
|
+
#
|
1854
|
+
# @example Request syntax with placeholder values
|
1855
|
+
#
|
1856
|
+
# resp = client.create_location({
|
1857
|
+
# location_name: "CustomInputLocationStringModel", # required
|
1858
|
+
# tags: [
|
1859
|
+
# {
|
1860
|
+
# key: "TagKey", # required
|
1861
|
+
# value: "TagValue", # required
|
1862
|
+
# },
|
1863
|
+
# ],
|
1864
|
+
# })
|
1865
|
+
#
|
1866
|
+
# @example Response structure
|
1867
|
+
#
|
1868
|
+
# resp.location.location_name #=> String
|
1869
|
+
# resp.location.location_arn #=> String
|
1870
|
+
#
|
1871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateLocation AWS API Documentation
|
1872
|
+
#
|
1873
|
+
# @overload create_location(params = {})
|
1874
|
+
# @param [Hash] params ({})
|
1875
|
+
def create_location(params = {}, options = {})
|
1876
|
+
req = build_request(:create_location, params)
|
1877
|
+
req.send_request(options)
|
1878
|
+
end
|
1879
|
+
|
1854
1880
|
# Defines a new matchmaking configuration for use with FlexMatch.
|
1855
1881
|
# Whether your are using FlexMatch with GameLift hosting or as a
|
1856
1882
|
# standalone matchmaking service, the matchmaking configuration sets out
|
1857
1883
|
# rules for matching players and forming teams. If you're also using
|
1858
1884
|
# GameLift hosting, it defines how to start game sessions for each
|
1859
1885
|
# match. Your matchmaking system can use multiple configurations to
|
1860
|
-
# handle different game scenarios. All matchmaking requests
|
1861
|
-
#
|
1862
|
-
#
|
1863
|
-
# that configuration.
|
1886
|
+
# handle different game scenarios. All matchmaking requests identify the
|
1887
|
+
# matchmaking configuration to use and provide player attributes
|
1888
|
+
# consistent with that configuration.
|
1864
1889
|
#
|
1865
1890
|
# To create a matchmaking configuration, you must provide the following:
|
1866
1891
|
# configuration name and FlexMatch mode (with or without GameLift
|
@@ -1872,9 +1897,7 @@ module Aws::GameLift
|
|
1872
1897
|
#
|
1873
1898
|
# In addition, you must set up an Amazon Simple Notification Service
|
1874
1899
|
# topic to receive matchmaking notifications. Provide the topic ARN in
|
1875
|
-
# the matchmaking configuration.
|
1876
|
-
# polling ticket status with DescribeMatchmaking, is only suitable for
|
1877
|
-
# games in development with low matchmaking usage.
|
1900
|
+
# the matchmaking configuration.
|
1878
1901
|
#
|
1879
1902
|
# **Learn more**
|
1880
1903
|
#
|
@@ -1882,19 +1905,10 @@ module Aws::GameLift
|
|
1882
1905
|
#
|
1883
1906
|
# [ Set up FlexMatch event notification][2]
|
1884
1907
|
#
|
1885
|
-
# **Related actions**
|
1886
|
-
#
|
1887
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
1888
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
1889
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
1890
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
1891
|
-
# task][3]
|
1892
|
-
#
|
1893
1908
|
#
|
1894
1909
|
#
|
1895
1910
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
|
1896
1911
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
1897
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
1898
1912
|
#
|
1899
1913
|
# @option params [required, String] :name
|
1900
1914
|
# A unique identifier for the matchmaking configuration. This name is
|
@@ -1962,11 +1976,11 @@ module Aws::GameLift
|
|
1962
1976
|
#
|
1963
1977
|
# @option params [Array<Types::GameProperty>] :game_properties
|
1964
1978
|
# A set of custom properties for a game session, formatted as key:value
|
1965
|
-
# pairs. These properties are passed to a game server process
|
1966
|
-
#
|
1967
|
-
#
|
1968
|
-
#
|
1969
|
-
#
|
1979
|
+
# pairs. These properties are passed to a game server process with a
|
1980
|
+
# request to start a new game session (see [Start a Game Session][1]).
|
1981
|
+
# This information is added to the new `GameSession` object that is
|
1982
|
+
# created for a successful match. This parameter is not used if
|
1983
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
1970
1984
|
#
|
1971
1985
|
#
|
1972
1986
|
#
|
@@ -1974,11 +1988,11 @@ module Aws::GameLift
|
|
1974
1988
|
#
|
1975
1989
|
# @option params [String] :game_session_data
|
1976
1990
|
# A set of custom game session properties, formatted as a single string
|
1977
|
-
# value. This data is passed to a game server process
|
1978
|
-
#
|
1979
|
-
#
|
1980
|
-
#
|
1981
|
-
#
|
1991
|
+
# value. This data is passed to a game server process with a request to
|
1992
|
+
# start a new game session (see [Start a Game Session][1]). This
|
1993
|
+
# information is added to the new `GameSession` object that is created
|
1994
|
+
# for a successful match. This parameter is not used if `FlexMatchMode`
|
1995
|
+
# is set to `STANDALONE`.
|
1982
1996
|
#
|
1983
1997
|
#
|
1984
1998
|
#
|
@@ -1988,9 +2002,9 @@ module Aws::GameLift
|
|
1988
2002
|
# The method used to backfill game sessions that are created with this
|
1989
2003
|
# matchmaking configuration. Specify `MANUAL` when your game manages
|
1990
2004
|
# backfill requests manually or does not use the match backfill feature.
|
1991
|
-
# Specify `AUTOMATIC` to have GameLift create a
|
1992
|
-
#
|
1993
|
-
#
|
2005
|
+
# Specify `AUTOMATIC` to have GameLift create a backfill request
|
2006
|
+
# whenever a game session has one or more open slots. Learn more about
|
2007
|
+
# manual and automatic backfill in [ Backfill Existing Games with
|
1994
2008
|
# FlexMatch][1]. Automatic backfill is not available when
|
1995
2009
|
# `FlexMatchMode` is set to `STANDALONE`.
|
1996
2010
|
#
|
@@ -2019,10 +2033,7 @@ module Aws::GameLift
|
|
2019
2033
|
# Web Services resources are useful for resource management, access
|
2020
2034
|
# management and cost allocation. For more information, see [ Tagging
|
2021
2035
|
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
2022
|
-
# Reference*.
|
2023
|
-
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
2024
|
-
# The maximum tag limit may be lower than stated. See the Amazon Web
|
2025
|
-
# Services General Reference for actual tagging limits.
|
2036
|
+
# Reference*.
|
2026
2037
|
#
|
2027
2038
|
#
|
2028
2039
|
#
|
@@ -2097,39 +2108,30 @@ module Aws::GameLift
|
|
2097
2108
|
# Creates a new rule set for FlexMatch matchmaking. A rule set describes
|
2098
2109
|
# the type of match to create, such as the number and size of teams. It
|
2099
2110
|
# also sets the parameters for acceptable player matches, such as
|
2100
|
-
# minimum skill level or character type.
|
2101
|
-
# MatchmakingConfiguration.
|
2111
|
+
# minimum skill level or character type.
|
2102
2112
|
#
|
2103
2113
|
# To create a matchmaking rule set, provide unique rule set name and the
|
2104
2114
|
# rule set body in JSON format. Rule sets must be defined in the same
|
2105
2115
|
# Region as the matchmaking configuration they are used with.
|
2106
2116
|
#
|
2107
2117
|
# Since matchmaking rule sets cannot be edited, it is a good idea to
|
2108
|
-
# check the rule set syntax using ValidateMatchmakingRuleSet before
|
2118
|
+
# check the rule set syntax using [ValidateMatchmakingRuleSet][1] before
|
2109
2119
|
# creating a new rule set.
|
2110
2120
|
#
|
2111
2121
|
# **Learn more**
|
2112
2122
|
#
|
2113
|
-
# * [Build a rule set][
|
2114
|
-
#
|
2115
|
-
# * [Design a matchmaker][2]
|
2116
|
-
#
|
2117
|
-
# * [Matchmaking with FlexMatch][3]
|
2123
|
+
# * [Build a rule set][2]
|
2118
2124
|
#
|
2119
|
-
#
|
2125
|
+
# * [Design a matchmaker][3]
|
2120
2126
|
#
|
2121
|
-
#
|
2122
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
2123
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
2124
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
2125
|
-
# task][4]
|
2127
|
+
# * [Matchmaking with FlexMatch][4]
|
2126
2128
|
#
|
2127
2129
|
#
|
2128
2130
|
#
|
2129
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2130
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-
|
2131
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-
|
2132
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/
|
2131
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html
|
2132
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
2133
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
|
2134
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html
|
2133
2135
|
#
|
2134
2136
|
# @option params [required, String] :name
|
2135
2137
|
# A unique identifier for the matchmaking rule set. A matchmaking
|
@@ -2148,10 +2150,7 @@ module Aws::GameLift
|
|
2148
2150
|
# Services resources are useful for resource management, access
|
2149
2151
|
# management and cost allocation. For more information, see [ Tagging
|
2150
2152
|
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
2151
|
-
# Reference*.
|
2152
|
-
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
2153
|
-
# The maximum tag limit may be lower than stated. See the Amazon Web
|
2154
|
-
# Services General Reference for actual tagging limits.
|
2153
|
+
# Reference*.
|
2155
2154
|
#
|
2156
2155
|
#
|
2157
2156
|
#
|
@@ -2194,32 +2193,29 @@ module Aws::GameLift
|
|
2194
2193
|
# player sessions can be created in any game session with an open slot
|
2195
2194
|
# that is in `ACTIVE` status and has a player creation policy of
|
2196
2195
|
# `ACCEPT_ALL`. You can add a group of players to a game session with
|
2197
|
-
# CreatePlayerSessions.
|
2196
|
+
# [CreatePlayerSessions][1] .
|
2198
2197
|
#
|
2199
2198
|
# To create a player session, specify a game session ID, player ID, and
|
2200
2199
|
# optionally a set of player data.
|
2201
2200
|
#
|
2202
2201
|
# If successful, a slot is reserved in the game session for the player
|
2203
|
-
# and a new
|
2204
|
-
# The player references the player session ID when sending a
|
2205
|
-
# request to the game session, and the game server can use it
|
2206
|
-
# validate the player reservation with the GameLift service. Player
|
2202
|
+
# and a new `PlayerSessions` object is returned with a player session
|
2203
|
+
# ID. The player references the player session ID when sending a
|
2204
|
+
# connection request to the game session, and the game server can use it
|
2205
|
+
# to validate the player reservation with the GameLift service. Player
|
2207
2206
|
# sessions cannot be updated.
|
2208
2207
|
#
|
2209
2208
|
# The maximum number of players per game session is 200. It is not
|
2210
2209
|
# adjustable.
|
2211
2210
|
#
|
2212
|
-
# *Available in Amazon GameLift Local.*
|
2213
|
-
#
|
2214
2211
|
# **Related actions**
|
2215
2212
|
#
|
2216
|
-
#
|
2217
|
-
# \| StartGameSessionPlacement \| DescribeGameSessionPlacement \| [All
|
2218
|
-
# APIs by task][1]
|
2213
|
+
# [All APIs by task][2]
|
2219
2214
|
#
|
2220
2215
|
#
|
2221
2216
|
#
|
2222
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2217
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html
|
2218
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2223
2219
|
#
|
2224
2220
|
# @option params [required, String] :game_session_id
|
2225
2221
|
# A unique identifier for the game session to add a player to.
|
@@ -2271,14 +2267,14 @@ module Aws::GameLift
|
|
2271
2267
|
# player sessions can be created in any game session with an open slot
|
2272
2268
|
# that is in `ACTIVE` status and has a player creation policy of
|
2273
2269
|
# `ACCEPT_ALL`. To add a single player to a game session, use
|
2274
|
-
# CreatePlayerSession
|
2270
|
+
# [CreatePlayerSession][1]
|
2275
2271
|
#
|
2276
2272
|
# To create player sessions, specify a game session ID and a list of
|
2277
2273
|
# player IDs. Optionally, provide a set of player data for each player
|
2278
2274
|
# ID.
|
2279
2275
|
#
|
2280
2276
|
# If successful, a slot is reserved in the game session for each player,
|
2281
|
-
# and new PlayerSession objects are returned with player session IDs.
|
2277
|
+
# and new `PlayerSession` objects are returned with player session IDs.
|
2282
2278
|
# Each player references their player session ID when sending a
|
2283
2279
|
# connection request to the game session, and the game server can use it
|
2284
2280
|
# to validate the player reservation with the GameLift service. Player
|
@@ -2287,17 +2283,14 @@ module Aws::GameLift
|
|
2287
2283
|
# The maximum number of players per game session is 200. It is not
|
2288
2284
|
# adjustable.
|
2289
2285
|
#
|
2290
|
-
# *Available in Amazon GameLift Local.*
|
2291
|
-
#
|
2292
2286
|
# **Related actions**
|
2293
2287
|
#
|
2294
|
-
#
|
2295
|
-
# \| StartGameSessionPlacement \| DescribeGameSessionPlacement \| [All
|
2296
|
-
# APIs by task][1]
|
2288
|
+
# [All APIs by task][2]
|
2297
2289
|
#
|
2298
2290
|
#
|
2299
2291
|
#
|
2300
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2292
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html
|
2293
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2301
2294
|
#
|
2302
2295
|
# @option params [required, String] :game_session_id
|
2303
2296
|
# A unique identifier for the game session to add players to.
|
@@ -2386,8 +2379,7 @@ module Aws::GameLift
|
|
2386
2379
|
#
|
2387
2380
|
# **Related actions**
|
2388
2381
|
#
|
2389
|
-
#
|
2390
|
-
# DeleteScript \| [All APIs by task][3]
|
2382
|
+
# [All APIs by task][3]
|
2391
2383
|
#
|
2392
2384
|
#
|
2393
2385
|
#
|
@@ -2397,13 +2389,21 @@ module Aws::GameLift
|
|
2397
2389
|
#
|
2398
2390
|
# @option params [String] :name
|
2399
2391
|
# A descriptive label that is associated with a script. Script names do
|
2400
|
-
# not need to be unique. You can use UpdateScript to change this
|
2401
|
-
# later.
|
2392
|
+
# not need to be unique. You can use [UpdateScript][1] to change this
|
2393
|
+
# value later.
|
2394
|
+
#
|
2395
|
+
#
|
2396
|
+
#
|
2397
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html
|
2402
2398
|
#
|
2403
2399
|
# @option params [String] :version
|
2404
|
-
# Version information
|
2405
|
-
#
|
2406
|
-
#
|
2400
|
+
# Version information associated with a build or script. Version strings
|
2401
|
+
# do not need to be unique. You can use [UpdateScript][1] to change this
|
2402
|
+
# value later.
|
2403
|
+
#
|
2404
|
+
#
|
2405
|
+
#
|
2406
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html
|
2407
2407
|
#
|
2408
2408
|
# @option params [Types::S3Location] :storage_location
|
2409
2409
|
# The location of the Amazon S3 bucket where a zipped file containing
|
@@ -2431,14 +2431,17 @@ module Aws::GameLift
|
|
2431
2431
|
# resources are useful for resource management, access management and
|
2432
2432
|
# cost allocation. For more information, see [ Tagging Amazon Web
|
2433
2433
|
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
2434
|
-
# Once the resource is created, you can use TagResource,
|
2435
|
-
# and ListTagsForResource to add, remove, and
|
2436
|
-
# limit may be lower than stated. See the
|
2437
|
-
# Reference for actual tagging limits.
|
2434
|
+
# Once the resource is created, you can use [TagResource][2],
|
2435
|
+
# [UntagResource][3], and [ListTagsForResource][4] to add, remove, and
|
2436
|
+
# view tags. The maximum tag limit may be lower than stated. See the
|
2437
|
+
# Amazon Web Services General Reference for actual tagging limits.
|
2438
2438
|
#
|
2439
2439
|
#
|
2440
2440
|
#
|
2441
2441
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
2442
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_TagResource.html
|
2443
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UntagResource.html
|
2444
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListTagsForResource.html
|
2442
2445
|
#
|
2443
2446
|
# @return [Types::CreateScriptOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2444
2447
|
#
|
@@ -2490,9 +2493,10 @@ module Aws::GameLift
|
|
2490
2493
|
# the VPC for your Amazon GameLift fleet and a virtual private cloud
|
2491
2494
|
# (VPC) in your Amazon Web Services account. VPC peering enables the
|
2492
2495
|
# game servers on your fleet to communicate directly with other Amazon
|
2493
|
-
# Web Services resources.
|
2494
|
-
# CreateVpcPeeringConnection to establish the peering connection.
|
2495
|
-
# more information, see [VPC Peering with Amazon GameLift
|
2496
|
+
# Web Services resources. After you've received authorization, use
|
2497
|
+
# [CreateVpcPeeringConnection][1] to establish the peering connection.
|
2498
|
+
# For more information, see [VPC Peering with Amazon GameLift
|
2499
|
+
# Fleets][2].
|
2496
2500
|
#
|
2497
2501
|
# You can peer with VPCs that are owned by any Amazon Web Services
|
2498
2502
|
# account you have access to, including the account that you use to
|
@@ -2514,21 +2518,19 @@ module Aws::GameLift
|
|
2514
2518
|
# that you want to delete the peering connection for, and (2) ID of the
|
2515
2519
|
# Amazon Web Services account that you use to manage Amazon GameLift.
|
2516
2520
|
#
|
2517
|
-
# The authorization remains valid for 24 hours unless it is canceled
|
2518
|
-
#
|
2519
|
-
#
|
2521
|
+
# The authorization remains valid for 24 hours unless it is canceled.
|
2522
|
+
# You must create or delete the peering connection while the
|
2523
|
+
# authorization is valid.
|
2520
2524
|
#
|
2521
2525
|
# **Related actions**
|
2522
2526
|
#
|
2523
|
-
#
|
2524
|
-
# DeleteVpcPeeringAuthorization \| CreateVpcPeeringConnection \|
|
2525
|
-
# DescribeVpcPeeringConnections \| DeleteVpcPeeringConnection \| [All
|
2526
|
-
# APIs by task][2]
|
2527
|
+
# [All APIs by task][3]
|
2527
2528
|
#
|
2528
2529
|
#
|
2529
2530
|
#
|
2530
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2531
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
2531
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html
|
2532
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html
|
2533
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2532
2534
|
#
|
2533
2535
|
# @option params [required, String] :game_lift_aws_account_id
|
2534
2536
|
# A unique identifier for the Amazon Web Services account that you use
|
@@ -2585,11 +2587,11 @@ module Aws::GameLift
|
|
2585
2587
|
# more information, see [VPC Peering with Amazon GameLift Fleets][1].
|
2586
2588
|
#
|
2587
2589
|
# Before calling this operation to establish the peering connection, you
|
2588
|
-
# first need to
|
2589
|
-
# you want to peer with. Once the authorization for the specified
|
2590
|
-
# issued, you have 24 hours to establish the connection. These
|
2591
|
-
# operations handle all tasks necessary to peer the two VPCs,
|
2592
|
-
# acceptance, updating routing tables, etc.
|
2590
|
+
# first need to use [CreateVpcPeeringAuthorization][2] and identify the
|
2591
|
+
# VPC you want to peer with. Once the authorization for the specified
|
2592
|
+
# VPC is issued, you have 24 hours to establish the connection. These
|
2593
|
+
# two operations handle all tasks necessary to peer the two VPCs,
|
2594
|
+
# including acceptance, updating routing tables, etc.
|
2593
2595
|
#
|
2594
2596
|
# To establish the connection, call this operation from the Amazon Web
|
2595
2597
|
# Services account that is used to manage the Amazon GameLift fleets.
|
@@ -2597,22 +2599,22 @@ module Aws::GameLift
|
|
2597
2599
|
# enable a VPC peering connection for; (2) The Amazon Web Services
|
2598
2600
|
# account with the VPC that you want to peer with; and (3) The ID of the
|
2599
2601
|
# VPC you want to peer with. This operation is asynchronous. If
|
2600
|
-
# successful, a
|
2601
|
-
#
|
2602
|
-
# DescribeVpcPeeringConnections, or by monitoring fleet events for
|
2603
|
-
# success or failure using DescribeFleetEvents.
|
2602
|
+
# successful, a connection request is created. You can use continuous
|
2603
|
+
# polling to track the request's status using
|
2604
|
+
# [DescribeVpcPeeringConnections][3] , or by monitoring fleet events for
|
2605
|
+
# success or failure using [DescribeFleetEvents][4] .
|
2604
2606
|
#
|
2605
2607
|
# **Related actions**
|
2606
2608
|
#
|
2607
|
-
#
|
2608
|
-
# DeleteVpcPeeringAuthorization \| CreateVpcPeeringConnection \|
|
2609
|
-
# DescribeVpcPeeringConnections \| DeleteVpcPeeringConnection \| [All
|
2610
|
-
# APIs by task][2]
|
2609
|
+
# [All APIs by task][5]
|
2611
2610
|
#
|
2612
2611
|
#
|
2613
2612
|
#
|
2614
2613
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html
|
2615
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
2614
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html
|
2615
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html
|
2616
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html
|
2617
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2616
2618
|
#
|
2617
2619
|
# @option params [required, String] :fleet_id
|
2618
2620
|
# A unique identifier for the fleet. You can use either the fleet ID or
|
@@ -2662,8 +2664,7 @@ module Aws::GameLift
|
|
2662
2664
|
#
|
2663
2665
|
# **Related actions**
|
2664
2666
|
#
|
2665
|
-
#
|
2666
|
-
# DeleteAlias \| ResolveAlias \| [All APIs by task][1]
|
2667
|
+
# [All APIs by task][1]
|
2667
2668
|
#
|
2668
2669
|
#
|
2669
2670
|
#
|
@@ -2701,10 +2702,7 @@ module Aws::GameLift
|
|
2701
2702
|
#
|
2702
2703
|
# [ Upload a Custom Server Build][1]
|
2703
2704
|
#
|
2704
|
-
#
|
2705
|
-
#
|
2706
|
-
# CreateBuild \| ListBuilds \| DescribeBuild \| UpdateBuild \|
|
2707
|
-
# DeleteBuild \| [All APIs by task][2]
|
2705
|
+
# [All APIs by task][2]
|
2708
2706
|
#
|
2709
2707
|
#
|
2710
2708
|
#
|
@@ -2738,9 +2736,8 @@ module Aws::GameLift
|
|
2738
2736
|
#
|
2739
2737
|
# <note markdown="1"> If the fleet being deleted has a VPC peering connection, you first
|
2740
2738
|
# need to get a valid authorization (good for 24 hours) by calling
|
2741
|
-
# CreateVpcPeeringAuthorization. You do not need to explicitly
|
2742
|
-
# the VPC peering connection
|
2743
|
-
# process.
|
2739
|
+
# [CreateVpcPeeringAuthorization][1]. You do not need to explicitly
|
2740
|
+
# delete the VPC peering connection.
|
2744
2741
|
#
|
2745
2742
|
# </note>
|
2746
2743
|
#
|
@@ -2751,20 +2748,12 @@ module Aws::GameLift
|
|
2751
2748
|
#
|
2752
2749
|
# **Learn more**
|
2753
2750
|
#
|
2754
|
-
# [Setting up GameLift Fleets][
|
2755
|
-
#
|
2756
|
-
# **Related actions**
|
2757
|
-
#
|
2758
|
-
# CreateFleetLocations \| UpdateFleetAttributes \| UpdateFleetCapacity
|
2759
|
-
# \| UpdateFleetPortSettings \| UpdateRuntimeConfiguration \|
|
2760
|
-
# StopFleetActions \| StartFleetActions \| PutScalingPolicy \|
|
2761
|
-
# DeleteFleet \| DeleteFleetLocations \| DeleteScalingPolicy \| [All
|
2762
|
-
# APIs by task][2]
|
2751
|
+
# [Setting up GameLift Fleets][2]
|
2763
2752
|
#
|
2764
2753
|
#
|
2765
2754
|
#
|
2766
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2767
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
2755
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html
|
2756
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2768
2757
|
#
|
2769
2758
|
# @option params [required, String] :fleet_id
|
2770
2759
|
# A unique identifier for the fleet to be deleted. You can use either
|
@@ -2803,18 +2792,9 @@ module Aws::GameLift
|
|
2803
2792
|
#
|
2804
2793
|
# [Setting up GameLift fleets][1]
|
2805
2794
|
#
|
2806
|
-
# **Related actions**
|
2807
|
-
#
|
2808
|
-
# CreateFleetLocations \| DescribeFleetLocationAttributes \|
|
2809
|
-
# DescribeFleetLocationCapacity \| DescribeFleetLocationUtilization \|
|
2810
|
-
# DescribeFleetAttributes \| DescribeFleetCapacity \|
|
2811
|
-
# DescribeFleetUtilization \| UpdateFleetCapacity \| StopFleetActions \|
|
2812
|
-
# DeleteFleetLocations \| [All APIs by task][2]
|
2813
|
-
#
|
2814
2795
|
#
|
2815
2796
|
#
|
2816
2797
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2817
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2818
2798
|
#
|
2819
2799
|
# @option params [required, String] :fleet_id
|
2820
2800
|
# A unique identifier for the fleet to delete locations for. You can use
|
@@ -2843,7 +2823,7 @@ module Aws::GameLift
|
|
2843
2823
|
# resp.fleet_arn #=> String
|
2844
2824
|
# resp.location_states #=> Array
|
2845
2825
|
# resp.location_states[0].location #=> String
|
2846
|
-
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
2826
|
+
# resp.location_states[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
2847
2827
|
#
|
2848
2828
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleetLocations AWS API Documentation
|
2849
2829
|
#
|
@@ -2888,22 +2868,13 @@ module Aws::GameLift
|
|
2888
2868
|
#
|
2889
2869
|
# [GameLift FleetIQ Guide][1]
|
2890
2870
|
#
|
2891
|
-
# **Related actions**
|
2892
|
-
#
|
2893
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
2894
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
2895
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
2896
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
2897
|
-
# task][2]
|
2898
|
-
#
|
2899
2871
|
#
|
2900
2872
|
#
|
2901
2873
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
2902
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
2903
2874
|
#
|
2904
2875
|
# @option params [required, String] :game_server_group_name
|
2905
|
-
# A unique identifier for the game server group. Use either the
|
2906
|
-
#
|
2876
|
+
# A unique identifier for the game server group. Use either the name or
|
2877
|
+
# ARN value.
|
2907
2878
|
#
|
2908
2879
|
# @option params [String] :delete_option
|
2909
2880
|
# The type of delete to perform. Options include the following:
|
@@ -2961,25 +2932,9 @@ module Aws::GameLift
|
|
2961
2932
|
# unfulfilled [StartGameSessionPlacement][1] requests that reference the
|
2962
2933
|
# queue will fail. To delete a queue, specify the queue name.
|
2963
2934
|
#
|
2964
|
-
# **Learn more**
|
2965
|
-
#
|
2966
|
-
# [ Using Multi-Region Queues][2]
|
2967
|
-
#
|
2968
|
-
# **Related actions**
|
2969
|
-
#
|
2970
|
-
# [CreateGameSessionQueue][3] \| [DescribeGameSessionQueues][4] \|
|
2971
|
-
# [UpdateGameSessionQueue][5] \| [DeleteGameSessionQueue][6] \| [All
|
2972
|
-
# APIs by task][7]
|
2973
|
-
#
|
2974
2935
|
#
|
2975
2936
|
#
|
2976
2937
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html
|
2977
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
2978
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
2979
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
2980
|
-
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
2981
|
-
# [6]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
2982
|
-
# [7]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2983
2938
|
#
|
2984
2939
|
# @option params [required, String] :name
|
2985
2940
|
# A descriptive label that is associated with game session queue. Queue
|
@@ -3003,21 +2958,39 @@ module Aws::GameLift
|
|
3003
2958
|
req.send_request(options)
|
3004
2959
|
end
|
3005
2960
|
|
3006
|
-
#
|
3007
|
-
# specify the configuration name. A matchmaking configuration cannot be
|
3008
|
-
# deleted if it is being used in any active matchmaking tickets.
|
2961
|
+
# Deletes a custom location.
|
3009
2962
|
#
|
3010
|
-
#
|
2963
|
+
# Before deleting a custom location, review any fleets currently using
|
2964
|
+
# the custom location and deregister the location if it is in use. For
|
2965
|
+
# more information see, [DeregisterCompute][1].
|
3011
2966
|
#
|
3012
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
3013
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
3014
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
3015
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
3016
|
-
# task][1]
|
3017
2967
|
#
|
3018
2968
|
#
|
2969
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html
|
3019
2970
|
#
|
3020
|
-
# [
|
2971
|
+
# @option params [required, String] :location_name
|
2972
|
+
# The location name of the custom location to be deleted.
|
2973
|
+
#
|
2974
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2975
|
+
#
|
2976
|
+
# @example Request syntax with placeholder values
|
2977
|
+
#
|
2978
|
+
# resp = client.delete_location({
|
2979
|
+
# location_name: "CustomLocationNameOrArnModel", # required
|
2980
|
+
# })
|
2981
|
+
#
|
2982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteLocation AWS API Documentation
|
2983
|
+
#
|
2984
|
+
# @overload delete_location(params = {})
|
2985
|
+
# @param [Hash] params ({})
|
2986
|
+
def delete_location(params = {}, options = {})
|
2987
|
+
req = build_request(:delete_location, params)
|
2988
|
+
req.send_request(options)
|
2989
|
+
end
|
2990
|
+
|
2991
|
+
# Permanently removes a FlexMatch matchmaking configuration. To delete,
|
2992
|
+
# specify the configuration name. A matchmaking configuration cannot be
|
2993
|
+
# deleted if it is being used in any active matchmaking tickets.
|
3021
2994
|
#
|
3022
2995
|
# @option params [required, String] :name
|
3023
2996
|
# A unique identifier for the matchmaking configuration. You can use
|
@@ -3050,18 +3023,9 @@ module Aws::GameLift
|
|
3050
3023
|
#
|
3051
3024
|
# ^
|
3052
3025
|
#
|
3053
|
-
# **Related actions**
|
3054
|
-
#
|
3055
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
3056
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
3057
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
3058
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
3059
|
-
# task][2]
|
3060
|
-
#
|
3061
3026
|
#
|
3062
3027
|
#
|
3063
3028
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
3064
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3065
3029
|
#
|
3066
3030
|
# @option params [required, String] :name
|
3067
3031
|
# A unique identifier for the matchmaking rule set to be deleted. (Note:
|
@@ -3090,19 +3054,12 @@ module Aws::GameLift
|
|
3090
3054
|
# policy, specify both the scaling policy name and the fleet ID it is
|
3091
3055
|
# associated with.
|
3092
3056
|
#
|
3093
|
-
# To temporarily suspend scaling policies,
|
3094
|
-
# operation suspends all policies for the fleet.
|
3095
|
-
#
|
3096
|
-
# **Related actions**
|
3097
|
-
#
|
3098
|
-
# DescribeFleetCapacity \| UpdateFleetCapacity \|
|
3099
|
-
# DescribeEC2InstanceLimits \| PutScalingPolicy \|
|
3100
|
-
# DescribeScalingPolicies \| DeleteScalingPolicy \| StopFleetActions \|
|
3101
|
-
# StartFleetActions \| [All APIs by task][1]
|
3057
|
+
# To temporarily suspend scaling policies, use [StopFleetActions][1].
|
3058
|
+
# This operation suspends all policies for the fleet.
|
3102
3059
|
#
|
3103
3060
|
#
|
3104
3061
|
#
|
3105
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
3062
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html
|
3106
3063
|
#
|
3107
3064
|
# @option params [required, String] :name
|
3108
3065
|
# A descriptive label that is associated with a fleet's scaling policy.
|
@@ -3146,8 +3103,7 @@ module Aws::GameLift
|
|
3146
3103
|
#
|
3147
3104
|
# **Related actions**
|
3148
3105
|
#
|
3149
|
-
#
|
3150
|
-
# DeleteScript \| [All APIs by task][2]
|
3106
|
+
# [All APIs by task][2]
|
3151
3107
|
#
|
3152
3108
|
#
|
3153
3109
|
#
|
@@ -3176,19 +3132,17 @@ module Aws::GameLift
|
|
3176
3132
|
end
|
3177
3133
|
|
3178
3134
|
# Cancels a pending VPC peering authorization for the specified VPC. If
|
3179
|
-
# you need to delete an existing VPC peering connection,
|
3180
|
-
# DeleteVpcPeeringConnection.
|
3135
|
+
# you need to delete an existing VPC peering connection, use
|
3136
|
+
# [DeleteVpcPeeringConnection][1].
|
3181
3137
|
#
|
3182
3138
|
# **Related actions**
|
3183
3139
|
#
|
3184
|
-
#
|
3185
|
-
# DeleteVpcPeeringAuthorization \| CreateVpcPeeringConnection \|
|
3186
|
-
# DescribeVpcPeeringConnections \| DeleteVpcPeeringConnection \| [All
|
3187
|
-
# APIs by task][1]
|
3140
|
+
# [All APIs by task][2]
|
3188
3141
|
#
|
3189
3142
|
#
|
3190
3143
|
#
|
3191
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
3144
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html
|
3145
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3192
3146
|
#
|
3193
3147
|
# @option params [required, String] :game_lift_aws_account_id
|
3194
3148
|
# A unique identifier for the Amazon Web Services account that you use
|
@@ -3227,9 +3181,7 @@ module Aws::GameLift
|
|
3227
3181
|
|
3228
3182
|
# Removes a VPC peering connection. To delete the connection, you must
|
3229
3183
|
# have a valid authorization for the VPC peering connection that you
|
3230
|
-
# want to delete
|
3231
|
-
# DescribeVpcPeeringAuthorizations or request a new one using
|
3232
|
-
# CreateVpcPeeringAuthorization.
|
3184
|
+
# want to delete..
|
3233
3185
|
#
|
3234
3186
|
# Once a valid authorization exists, call this operation from the Amazon
|
3235
3187
|
# Web Services account that is used to manage the Amazon GameLift
|
@@ -3238,10 +3190,7 @@ module Aws::GameLift
|
|
3238
3190
|
#
|
3239
3191
|
# **Related actions**
|
3240
3192
|
#
|
3241
|
-
#
|
3242
|
-
# DeleteVpcPeeringAuthorization \| CreateVpcPeeringConnection \|
|
3243
|
-
# DescribeVpcPeeringConnections \| DeleteVpcPeeringConnection \| [All
|
3244
|
-
# APIs by task][1]
|
3193
|
+
# [All APIs by task][1]
|
3245
3194
|
#
|
3246
3195
|
#
|
3247
3196
|
#
|
@@ -3253,9 +3202,7 @@ module Aws::GameLift
|
|
3253
3202
|
# either the fleet ID or ARN value.
|
3254
3203
|
#
|
3255
3204
|
# @option params [required, String] :vpc_peering_connection_id
|
3256
|
-
# A unique identifier for a VPC peering connection.
|
3257
|
-
# included in the VpcPeeringConnection object, which can be retrieved by
|
3258
|
-
# calling DescribeVpcPeeringConnections.
|
3205
|
+
# A unique identifier for a VPC peering connection.
|
3259
3206
|
#
|
3260
3207
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3261
3208
|
#
|
@@ -3275,6 +3222,34 @@ module Aws::GameLift
|
|
3275
3222
|
req.send_request(options)
|
3276
3223
|
end
|
3277
3224
|
|
3225
|
+
# Removes a compute resource from the specified fleet. Deregister your
|
3226
|
+
# compute resources before you delete the compute.
|
3227
|
+
#
|
3228
|
+
# @option params [required, String] :fleet_id
|
3229
|
+
# >A unique identifier for the fleet the compute resource is
|
3230
|
+
# registered to.
|
3231
|
+
#
|
3232
|
+
# @option params [required, String] :compute_name
|
3233
|
+
# The name of the compute resource you want to delete.
|
3234
|
+
#
|
3235
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3236
|
+
#
|
3237
|
+
# @example Request syntax with placeholder values
|
3238
|
+
#
|
3239
|
+
# resp = client.deregister_compute({
|
3240
|
+
# fleet_id: "FleetIdOrArn", # required
|
3241
|
+
# compute_name: "ComputeNameOrArn", # required
|
3242
|
+
# })
|
3243
|
+
#
|
3244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterCompute AWS API Documentation
|
3245
|
+
#
|
3246
|
+
# @overload deregister_compute(params = {})
|
3247
|
+
# @param [Hash] params ({})
|
3248
|
+
def deregister_compute(params = {}, options = {})
|
3249
|
+
req = build_request(:deregister_compute, params)
|
3250
|
+
req.send_request(options)
|
3251
|
+
end
|
3252
|
+
|
3278
3253
|
# **This operation is used with the GameLift FleetIQ solution and game
|
3279
3254
|
# server groups.**
|
3280
3255
|
#
|
@@ -3290,20 +3265,13 @@ module Aws::GameLift
|
|
3290
3265
|
#
|
3291
3266
|
# [GameLift FleetIQ Guide][1]
|
3292
3267
|
#
|
3293
|
-
# **Related actions**
|
3294
|
-
#
|
3295
|
-
# RegisterGameServer \| ListGameServers \| ClaimGameServer \|
|
3296
|
-
# DescribeGameServer \| UpdateGameServer \| DeregisterGameServer \| [All
|
3297
|
-
# APIs by task][2]
|
3298
|
-
#
|
3299
3268
|
#
|
3300
3269
|
#
|
3301
3270
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3302
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
3303
3271
|
#
|
3304
3272
|
# @option params [required, String] :game_server_group_name
|
3305
3273
|
# A unique identifier for the game server group where the game server is
|
3306
|
-
# running.
|
3274
|
+
# running.
|
3307
3275
|
#
|
3308
3276
|
# @option params [required, String] :game_server_id
|
3309
3277
|
# A custom string that uniquely identifies the game server to
|
@@ -3336,8 +3304,7 @@ module Aws::GameLift
|
|
3336
3304
|
#
|
3337
3305
|
# **Related actions**
|
3338
3306
|
#
|
3339
|
-
#
|
3340
|
-
# DeleteAlias \| ResolveAlias \| [All APIs by task][1]
|
3307
|
+
# [All APIs by task][1]
|
3341
3308
|
#
|
3342
3309
|
#
|
3343
3310
|
#
|
@@ -3386,10 +3353,7 @@ module Aws::GameLift
|
|
3386
3353
|
#
|
3387
3354
|
# [ Upload a Custom Server Build][1]
|
3388
3355
|
#
|
3389
|
-
#
|
3390
|
-
#
|
3391
|
-
# CreateBuild \| ListBuilds \| DescribeBuild \| UpdateBuild \|
|
3392
|
-
# DeleteBuild \| [All APIs by task][2]
|
3356
|
+
# [All APIs by task][2]
|
3393
3357
|
#
|
3394
3358
|
#
|
3395
3359
|
#
|
@@ -3420,6 +3384,7 @@ module Aws::GameLift
|
|
3420
3384
|
# resp.build.size_on_disk #=> Integer
|
3421
3385
|
# resp.build.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
3422
3386
|
# resp.build.creation_time #=> Time
|
3387
|
+
# resp.build.server_sdk_version #=> String
|
3423
3388
|
#
|
3424
3389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeBuild AWS API Documentation
|
3425
3390
|
#
|
@@ -3430,6 +3395,52 @@ module Aws::GameLift
|
|
3430
3395
|
req.send_request(options)
|
3431
3396
|
end
|
3432
3397
|
|
3398
|
+
# Retrieves properties for a compute resource. To request a compute
|
3399
|
+
# resource specify the fleet ID and compute name. If successful,
|
3400
|
+
# GameLift returns an object containing the build properties.
|
3401
|
+
#
|
3402
|
+
# @option params [required, String] :fleet_id
|
3403
|
+
# A unique identifier for the fleet the compute is registered to.
|
3404
|
+
#
|
3405
|
+
# @option params [required, String] :compute_name
|
3406
|
+
# A descriptive label that is associated with the compute resource
|
3407
|
+
# registered to your fleet.
|
3408
|
+
#
|
3409
|
+
# @return [Types::DescribeComputeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3410
|
+
#
|
3411
|
+
# * {Types::DescribeComputeOutput#compute #compute} => Types::Compute
|
3412
|
+
#
|
3413
|
+
# @example Request syntax with placeholder values
|
3414
|
+
#
|
3415
|
+
# resp = client.describe_compute({
|
3416
|
+
# fleet_id: "FleetIdOrArn", # required
|
3417
|
+
# compute_name: "ComputeNameOrArn", # required
|
3418
|
+
# })
|
3419
|
+
#
|
3420
|
+
# @example Response structure
|
3421
|
+
#
|
3422
|
+
# resp.compute.fleet_id #=> String
|
3423
|
+
# resp.compute.fleet_arn #=> String
|
3424
|
+
# resp.compute.compute_name #=> String
|
3425
|
+
# resp.compute.compute_arn #=> String
|
3426
|
+
# resp.compute.ip_address #=> String
|
3427
|
+
# resp.compute.dns_name #=> String
|
3428
|
+
# resp.compute.compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
3429
|
+
# resp.compute.location #=> String
|
3430
|
+
# resp.compute.creation_time #=> Time
|
3431
|
+
# resp.compute.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
3432
|
+
# resp.compute.type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge"
|
3433
|
+
# resp.compute.game_lift_service_sdk_endpoint #=> String
|
3434
|
+
#
|
3435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeCompute AWS API Documentation
|
3436
|
+
#
|
3437
|
+
# @overload describe_compute(params = {})
|
3438
|
+
# @param [Hash] params ({})
|
3439
|
+
def describe_compute(params = {}, options = {})
|
3440
|
+
req = build_request(:describe_compute, params)
|
3441
|
+
req.send_request(options)
|
3442
|
+
end
|
3443
|
+
|
3433
3444
|
# Retrieves the instance limits and current utilization for an Amazon
|
3434
3445
|
# Web Services Region or location. Instance limits control the number of
|
3435
3446
|
# instances, per instance type, per location, that your Amazon Web
|
@@ -3484,18 +3495,10 @@ module Aws::GameLift
|
|
3484
3495
|
#
|
3485
3496
|
# [Setting up GameLift fleets][2]
|
3486
3497
|
#
|
3487
|
-
# **Related actions**
|
3488
|
-
#
|
3489
|
-
# CreateFleet \| UpdateFleetCapacity \| PutScalingPolicy \|
|
3490
|
-
# DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
3491
|
-
# DescribeFleetLocationAttributes \| UpdateFleetAttributes \|
|
3492
|
-
# StopFleetActions \| DeleteFleet \| [All APIs by task][3]
|
3493
|
-
#
|
3494
3498
|
#
|
3495
3499
|
#
|
3496
3500
|
# [1]: http://aws.amazon.com/ec2/instance-types/
|
3497
3501
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3498
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3499
3502
|
#
|
3500
3503
|
# @option params [String] :ec2_instance_type
|
3501
3504
|
# Name of an Amazon EC2 instance type that is supported in GameLift. A
|
@@ -3562,18 +3565,9 @@ module Aws::GameLift
|
|
3562
3565
|
#
|
3563
3566
|
# [Setting up GameLift fleets][1]
|
3564
3567
|
#
|
3565
|
-
# **Related actions**
|
3566
|
-
#
|
3567
|
-
# ListFleets \| DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
3568
|
-
# DescribeFleetCapacity \| DescribeFleetEvents \|
|
3569
|
-
# DescribeFleetLocationAttributes \| DescribeFleetPortSettings \|
|
3570
|
-
# DescribeFleetUtilization \| DescribeRuntimeConfiguration \|
|
3571
|
-
# DescribeScalingPolicies \| [All APIs by task][2]
|
3572
|
-
#
|
3573
3568
|
#
|
3574
3569
|
#
|
3575
3570
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3576
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3577
3571
|
#
|
3578
3572
|
# @option params [Array<String>] :fleet_ids
|
3579
3573
|
# A list of unique fleet identifiers to retrieve attributes for. You can
|
@@ -3619,7 +3613,7 @@ module Aws::GameLift
|
|
3619
3613
|
# resp.fleet_attributes[0].name #=> String
|
3620
3614
|
# resp.fleet_attributes[0].creation_time #=> Time
|
3621
3615
|
# resp.fleet_attributes[0].termination_time #=> Time
|
3622
|
-
# resp.fleet_attributes[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
3616
|
+
# resp.fleet_attributes[0].status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
3623
3617
|
# resp.fleet_attributes[0].build_id #=> String
|
3624
3618
|
# resp.fleet_attributes[0].build_arn #=> String
|
3625
3619
|
# resp.fleet_attributes[0].script_id #=> String
|
@@ -3638,6 +3632,8 @@ module Aws::GameLift
|
|
3638
3632
|
# resp.fleet_attributes[0].stopped_actions[0] #=> String, one of "AUTO_SCALING"
|
3639
3633
|
# resp.fleet_attributes[0].instance_role_arn #=> String
|
3640
3634
|
# resp.fleet_attributes[0].certificate_configuration.certificate_type #=> String, one of "DISABLED", "GENERATED"
|
3635
|
+
# resp.fleet_attributes[0].compute_type #=> String, one of "EC2", "ANYWHERE"
|
3636
|
+
# resp.fleet_attributes[0].anywhere_configuration.cost #=> String
|
3641
3637
|
# resp.next_token #=> String
|
3642
3638
|
#
|
3643
3639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetAttributes AWS API Documentation
|
@@ -3653,8 +3649,7 @@ module Aws::GameLift
|
|
3653
3649
|
# data returned includes the current fleet capacity (number of EC2
|
3654
3650
|
# instances), and settings that can control how capacity scaling. For
|
3655
3651
|
# fleets with remote locations, this operation retrieves data for the
|
3656
|
-
# fleet's home Region only.
|
3657
|
-
# capacity settings for a fleet's remote locations.
|
3652
|
+
# fleet's home Region only.
|
3658
3653
|
#
|
3659
3654
|
# This operation can be used in the following ways:
|
3660
3655
|
#
|
@@ -3667,7 +3662,7 @@ module Aws::GameLift
|
|
3667
3662
|
# When requesting multiple fleets, use the pagination parameters to
|
3668
3663
|
# retrieve results as a set of sequential pages.
|
3669
3664
|
#
|
3670
|
-
# If successful, a FleetCapacity object is returned for each requested
|
3665
|
+
# If successful, a `FleetCapacity` object is returned for each requested
|
3671
3666
|
# fleet ID. Each FleetCapacity object includes a `Location` property,
|
3672
3667
|
# which is set to the fleet's home Region. When a list of fleet IDs is
|
3673
3668
|
# provided, attribute objects are returned only for fleets that
|
@@ -3685,22 +3680,13 @@ module Aws::GameLift
|
|
3685
3680
|
#
|
3686
3681
|
# [GameLift metrics for fleets][2]
|
3687
3682
|
#
|
3688
|
-
# **Related actions**
|
3689
|
-
#
|
3690
|
-
# ListFleets \| DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
3691
|
-
# DescribeFleetCapacity \| DescribeFleetEvents \|
|
3692
|
-
# DescribeFleetLocationAttributes \| DescribeFleetPortSettings \|
|
3693
|
-
# DescribeFleetUtilization \| DescribeRuntimeConfiguration \|
|
3694
|
-
# DescribeScalingPolicies \| [All APIs by task][3]
|
3695
|
-
#
|
3696
3683
|
#
|
3697
3684
|
#
|
3698
3685
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3699
3686
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
3700
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3701
3687
|
#
|
3702
3688
|
# @option params [Array<String>] :fleet_ids
|
3703
|
-
# A unique identifier for the fleet
|
3689
|
+
# A unique identifier for the fleet to retrieve capacity information
|
3704
3690
|
# for. You can use either the fleet ID or ARN value. Leave this
|
3705
3691
|
# parameter empty to retrieve capacity information for all fleets.
|
3706
3692
|
#
|
@@ -3774,18 +3760,9 @@ module Aws::GameLift
|
|
3774
3760
|
#
|
3775
3761
|
# [Setting up GameLift fleets][1]
|
3776
3762
|
#
|
3777
|
-
# **Related actions**
|
3778
|
-
#
|
3779
|
-
# ListFleets \| DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
3780
|
-
# DescribeFleetCapacity \| DescribeFleetEvents \|
|
3781
|
-
# DescribeFleetLocationAttributes \| DescribeFleetPortSettings \|
|
3782
|
-
# DescribeFleetUtilization \| DescribeRuntimeConfiguration \|
|
3783
|
-
# DescribeScalingPolicies \| [All APIs by task][2]
|
3784
|
-
#
|
3785
3763
|
#
|
3786
3764
|
#
|
3787
3765
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3788
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3789
3766
|
#
|
3790
3767
|
# @option params [required, String] :fleet_id
|
3791
3768
|
# A unique identifier for the fleet to get event logs for. You can use
|
@@ -3835,7 +3812,7 @@ module Aws::GameLift
|
|
3835
3812
|
# resp.events #=> Array
|
3836
3813
|
# resp.events[0].event_id #=> String
|
3837
3814
|
# resp.events[0].resource_id #=> String
|
3838
|
-
# resp.events[0].event_code #=> String, one of "GENERIC_EVENT", "FLEET_CREATED", "FLEET_DELETED", "FLEET_SCALING_EVENT", "FLEET_STATE_DOWNLOADING", "FLEET_STATE_VALIDATING", "FLEET_STATE_BUILDING", "FLEET_STATE_ACTIVATING", "FLEET_STATE_ACTIVE", "FLEET_STATE_ERROR", "FLEET_INITIALIZATION_FAILED", "FLEET_BINARY_DOWNLOAD_FAILED", "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "FLEET_VALIDATION_TIMED_OUT", "FLEET_ACTIVATION_FAILED", "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "SERVER_PROCESS_INVALID_PATH", "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "SERVER_PROCESS_CRASHED", "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", "GAME_SESSION_ACTIVATION_TIMEOUT", "FLEET_CREATION_EXTRACTING_BUILD", "FLEET_CREATION_RUNNING_INSTALLER", "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", "FLEET_VPC_PEERING_SUCCEEDED", "FLEET_VPC_PEERING_FAILED", "FLEET_VPC_PEERING_DELETED", "INSTANCE_INTERRUPTED"
|
3815
|
+
# resp.events[0].event_code #=> String, one of "GENERIC_EVENT", "FLEET_CREATED", "FLEET_DELETED", "FLEET_SCALING_EVENT", "FLEET_STATE_DOWNLOADING", "FLEET_STATE_VALIDATING", "FLEET_STATE_BUILDING", "FLEET_STATE_ACTIVATING", "FLEET_STATE_ACTIVE", "FLEET_STATE_ERROR", "FLEET_INITIALIZATION_FAILED", "FLEET_BINARY_DOWNLOAD_FAILED", "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "FLEET_VALIDATION_TIMED_OUT", "FLEET_ACTIVATION_FAILED", "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "SERVER_PROCESS_INVALID_PATH", "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "SERVER_PROCESS_CRASHED", "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", "GAME_SESSION_ACTIVATION_TIMEOUT", "FLEET_CREATION_EXTRACTING_BUILD", "FLEET_CREATION_RUNNING_INSTALLER", "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", "FLEET_VPC_PEERING_SUCCEEDED", "FLEET_VPC_PEERING_FAILED", "FLEET_VPC_PEERING_DELETED", "INSTANCE_INTERRUPTED", "INSTANCE_RECYCLED"
|
3839
3816
|
# resp.events[0].message #=> String
|
3840
3817
|
# resp.events[0].event_time #=> Time
|
3841
3818
|
# resp.events[0].pre_signed_log_url #=> String
|
@@ -3875,18 +3852,9 @@ module Aws::GameLift
|
|
3875
3852
|
#
|
3876
3853
|
# [Setting up GameLift fleets][1]
|
3877
3854
|
#
|
3878
|
-
# **Related actions**
|
3879
|
-
#
|
3880
|
-
# CreateFleetLocations \| DescribeFleetLocationAttributes \|
|
3881
|
-
# DescribeFleetLocationCapacity \| DescribeFleetLocationUtilization \|
|
3882
|
-
# DescribeFleetAttributes \| DescribeFleetCapacity \|
|
3883
|
-
# DescribeFleetUtilization \| UpdateFleetCapacity \| StopFleetActions \|
|
3884
|
-
# DeleteFleetLocations \| [All APIs by task][2]
|
3885
|
-
#
|
3886
3855
|
#
|
3887
3856
|
#
|
3888
3857
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3889
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3890
3858
|
#
|
3891
3859
|
# @option params [required, String] :fleet_id
|
3892
3860
|
# A unique identifier for the fleet to retrieve remote locations for.
|
@@ -3932,7 +3900,7 @@ module Aws::GameLift
|
|
3932
3900
|
# resp.fleet_arn #=> String
|
3933
3901
|
# resp.location_attributes #=> Array
|
3934
3902
|
# resp.location_attributes[0].location_state.location #=> String
|
3935
|
-
# resp.location_attributes[0].location_state.status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED"
|
3903
|
+
# resp.location_attributes[0].location_state.status #=> String, one of "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED", "NOT_FOUND"
|
3936
3904
|
# resp.location_attributes[0].stopped_actions #=> Array
|
3937
3905
|
# resp.location_attributes[0].stopped_actions[0] #=> String, one of "AUTO_SCALING"
|
3938
3906
|
# resp.location_attributes[0].update_status #=> String, one of "PENDING_UPDATE"
|
@@ -3965,19 +3933,10 @@ module Aws::GameLift
|
|
3965
3933
|
#
|
3966
3934
|
# [GameLift metrics for fleets][2]
|
3967
3935
|
#
|
3968
|
-
# **Related actions**
|
3969
|
-
#
|
3970
|
-
# CreateFleetLocations \| DescribeFleetLocationAttributes \|
|
3971
|
-
# DescribeFleetLocationCapacity \| DescribeFleetLocationUtilization \|
|
3972
|
-
# DescribeFleetAttributes \| DescribeFleetCapacity \|
|
3973
|
-
# DescribeFleetUtilization \| UpdateFleetCapacity \| StopFleetActions \|
|
3974
|
-
# DeleteFleetLocations \| [All APIs by task][3]
|
3975
|
-
#
|
3976
3936
|
#
|
3977
3937
|
#
|
3978
3938
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3979
3939
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
3980
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3981
3940
|
#
|
3982
3941
|
# @option params [required, String] :fleet_id
|
3983
3942
|
# A unique identifier for the fleet to request location capacity for.
|
@@ -4039,19 +3998,10 @@ module Aws::GameLift
|
|
4039
3998
|
#
|
4040
3999
|
# [GameLift metrics for fleets][2]
|
4041
4000
|
#
|
4042
|
-
# **Related actions**
|
4043
|
-
#
|
4044
|
-
# CreateFleetLocations \| DescribeFleetLocationAttributes \|
|
4045
|
-
# DescribeFleetLocationCapacity \| DescribeFleetLocationUtilization \|
|
4046
|
-
# DescribeFleetAttributes \| DescribeFleetCapacity \|
|
4047
|
-
# DescribeFleetUtilization \| UpdateFleetCapacity \| StopFleetActions \|
|
4048
|
-
# DeleteFleetLocations \| [All APIs by task][3]
|
4049
|
-
#
|
4050
4001
|
#
|
4051
4002
|
#
|
4052
4003
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
4053
4004
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
4054
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
4055
4005
|
#
|
4056
4006
|
# @option params [required, String] :fleet_id
|
4057
4007
|
# A unique identifier for the fleet to request location utilization for.
|
@@ -4107,7 +4057,7 @@ module Aws::GameLift
|
|
4107
4057
|
# specify the fleet ID and a location. Port setting updates can take
|
4108
4058
|
# time to propagate across all locations.
|
4109
4059
|
#
|
4110
|
-
# If successful, a set of IpPermission objects is returned for the
|
4060
|
+
# If successful, a set of `IpPermission` objects is returned for the
|
4111
4061
|
# requested fleet ID. When a location is specified, a pending status is
|
4112
4062
|
# included. If the requested fleet has been deleted, the result set is
|
4113
4063
|
# empty.
|
@@ -4116,18 +4066,9 @@ module Aws::GameLift
|
|
4116
4066
|
#
|
4117
4067
|
# [Setting up GameLift fleets][1]
|
4118
4068
|
#
|
4119
|
-
# **Related actions**
|
4120
|
-
#
|
4121
|
-
# ListFleets \| DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
4122
|
-
# DescribeFleetCapacity \| DescribeFleetEvents \|
|
4123
|
-
# DescribeFleetLocationAttributes \| DescribeFleetPortSettings \|
|
4124
|
-
# DescribeFleetUtilization \| DescribeRuntimeConfiguration \|
|
4125
|
-
# DescribeScalingPolicies \| [All APIs by task][2]
|
4126
|
-
#
|
4127
4069
|
#
|
4128
4070
|
#
|
4129
4071
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
4130
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
4131
4072
|
#
|
4132
4073
|
# @option params [required, String] :fleet_id
|
4133
4074
|
# A unique identifier for the fleet to retrieve port settings for. You
|
@@ -4177,8 +4118,8 @@ module Aws::GameLift
|
|
4177
4118
|
# data provides a snapshot of how the fleet's hosting resources are
|
4178
4119
|
# currently being used. For fleets with remote locations, this operation
|
4179
4120
|
# retrieves data for the fleet's home Region only. See
|
4180
|
-
# DescribeFleetLocationUtilization to get utilization statistics
|
4181
|
-
# fleet's remote locations.
|
4121
|
+
# [DescribeFleetLocationUtilization][1] to get utilization statistics
|
4122
|
+
# for a fleet's remote locations.
|
4182
4123
|
#
|
4183
4124
|
# This operation can be used in the following ways:
|
4184
4125
|
#
|
@@ -4191,7 +4132,7 @@ module Aws::GameLift
|
|
4191
4132
|
# When requesting multiple fleets, use the pagination parameters to
|
4192
4133
|
# retrieve results as a set of sequential pages.
|
4193
4134
|
#
|
4194
|
-
# If successful, a FleetUtilization object is returned for each
|
4135
|
+
# If successful, a [FleetUtilization][2] object is returned for each
|
4195
4136
|
# requested fleet ID, unless the fleet identifier is not found. Each
|
4196
4137
|
# fleet utilization object includes a `Location` property, which is set
|
4197
4138
|
# to the fleet's home Region.
|
@@ -4204,26 +4145,19 @@ module Aws::GameLift
|
|
4204
4145
|
#
|
4205
4146
|
# **Learn more**
|
4206
4147
|
#
|
4207
|
-
# [Setting up GameLift Fleets][
|
4208
|
-
#
|
4209
|
-
# [GameLift Metrics for Fleets][2]
|
4210
|
-
#
|
4211
|
-
# **Related actions**
|
4148
|
+
# [Setting up GameLift Fleets][3]
|
4212
4149
|
#
|
4213
|
-
#
|
4214
|
-
# DescribeFleetCapacity \| DescribeFleetEvents \|
|
4215
|
-
# DescribeFleetLocationAttributes \| DescribeFleetPortSettings \|
|
4216
|
-
# DescribeFleetUtilization \| DescribeRuntimeConfiguration \|
|
4217
|
-
# DescribeScalingPolicies \| [All APIs by task][3]
|
4150
|
+
# [GameLift Metrics for Fleets][4]
|
4218
4151
|
#
|
4219
4152
|
#
|
4220
4153
|
#
|
4221
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
4222
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
4223
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
4154
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html
|
4155
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html
|
4156
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
4157
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
4224
4158
|
#
|
4225
4159
|
# @option params [Array<String>] :fleet_ids
|
4226
|
-
# A unique identifier for the fleet
|
4160
|
+
# A unique identifier for the fleet to retrieve utilization data for.
|
4227
4161
|
# You can use either the fleet ID or ARN value. To retrieve attributes
|
4228
4162
|
# for all current fleets, do not include this parameter.
|
4229
4163
|
#
|
@@ -4290,20 +4224,13 @@ module Aws::GameLift
|
|
4290
4224
|
#
|
4291
4225
|
# [GameLift FleetIQ Guide][1]
|
4292
4226
|
#
|
4293
|
-
# **Related actions**
|
4294
|
-
#
|
4295
|
-
# RegisterGameServer \| ListGameServers \| ClaimGameServer \|
|
4296
|
-
# DescribeGameServer \| UpdateGameServer \| DeregisterGameServer \| [All
|
4297
|
-
# APIs by task][2]
|
4298
|
-
#
|
4299
4227
|
#
|
4300
4228
|
#
|
4301
4229
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
4302
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
4303
4230
|
#
|
4304
4231
|
# @option params [required, String] :game_server_group_name
|
4305
4232
|
# A unique identifier for the game server group where the game server is
|
4306
|
-
# running.
|
4233
|
+
# running.
|
4307
4234
|
#
|
4308
4235
|
# @option params [required, String] :game_server_id
|
4309
4236
|
# A custom string that uniquely identifies the game server information
|
@@ -4353,28 +4280,19 @@ module Aws::GameLift
|
|
4353
4280
|
# access the Auto Scaling group directly.
|
4354
4281
|
#
|
4355
4282
|
# To get attributes for a game server group, provide a group name or ARN
|
4356
|
-
# value. If successful, a GameServerGroup object is returned.
|
4283
|
+
# value. If successful, a `GameServerGroup` object is returned.
|
4357
4284
|
#
|
4358
4285
|
# **Learn more**
|
4359
4286
|
#
|
4360
4287
|
# [GameLift FleetIQ Guide][1]
|
4361
4288
|
#
|
4362
|
-
# **Related actions**
|
4363
|
-
#
|
4364
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
4365
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
4366
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
4367
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
4368
|
-
# task][2]
|
4369
|
-
#
|
4370
4289
|
#
|
4371
4290
|
#
|
4372
4291
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
4373
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
4374
4292
|
#
|
4375
4293
|
# @option params [required, String] :game_server_group_name
|
4376
|
-
# A unique identifier for the game server group. Use either the
|
4377
|
-
#
|
4294
|
+
# A unique identifier for the game server group. Use either the name or
|
4295
|
+
# ARN value.
|
4378
4296
|
#
|
4379
4297
|
# @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4380
4298
|
#
|
@@ -4419,9 +4337,7 @@ module Aws::GameLift
|
|
4419
4337
|
# Retrieves status information about the Amazon EC2 instances associated
|
4420
4338
|
# with a GameLift FleetIQ game server group. Use this operation to
|
4421
4339
|
# detect when instances are active or not available to host new game
|
4422
|
-
# servers.
|
4423
|
-
# call DescribeGameServerGroup or access the corresponding Auto Scaling
|
4424
|
-
# group properties.
|
4340
|
+
# servers.
|
4425
4341
|
#
|
4426
4342
|
# To request status for all instances in the game server group, provide
|
4427
4343
|
# a game server group ID only. To request status for specific instances,
|
@@ -4438,22 +4354,13 @@ module Aws::GameLift
|
|
4438
4354
|
#
|
4439
4355
|
# [GameLift FleetIQ Guide][1]
|
4440
4356
|
#
|
4441
|
-
# **Related actions**
|
4442
|
-
#
|
4443
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
4444
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
4445
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
4446
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
4447
|
-
# task][2]
|
4448
|
-
#
|
4449
4357
|
#
|
4450
4358
|
#
|
4451
4359
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
4452
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
4453
4360
|
#
|
4454
4361
|
# @option params [required, String] :game_server_group_name
|
4455
|
-
# A unique identifier for the game server group. Use either the
|
4456
|
-
#
|
4362
|
+
# A unique identifier for the game server group. Use either the name or
|
4363
|
+
# ARN value.
|
4457
4364
|
#
|
4458
4365
|
# @option params [Array<String>] :instance_ids
|
4459
4366
|
# The Amazon EC2 instance IDs that you want to retrieve status on.
|
@@ -4508,10 +4415,7 @@ module Aws::GameLift
|
|
4508
4415
|
# Retrieves additional game session properties, including the game
|
4509
4416
|
# session protection policy in force, a set of one or more game sessions
|
4510
4417
|
# in a specific fleet location. You can optionally filter the results by
|
4511
|
-
# current game session status.
|
4512
|
-
# request a set of active game sessions that are filtered by certain
|
4513
|
-
# criteria. To retrieve all game session properties, use
|
4514
|
-
# DescribeGameSessions.
|
4418
|
+
# current game session status.
|
4515
4419
|
#
|
4516
4420
|
# This operation can be used in the following ways:
|
4517
4421
|
#
|
@@ -4540,13 +4444,7 @@ module Aws::GameLift
|
|
4540
4444
|
#
|
4541
4445
|
# [Find a game session][1]
|
4542
4446
|
#
|
4543
|
-
#
|
4544
|
-
#
|
4545
|
-
# CreateGameSession \| DescribeGameSessions \|
|
4546
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
4547
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
4548
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
4549
|
-
# by task][2]
|
4447
|
+
# [All APIs by task][2]
|
4550
4448
|
#
|
4551
4449
|
#
|
4552
4450
|
#
|
@@ -4566,9 +4464,9 @@ module Aws::GameLift
|
|
4566
4464
|
# value.
|
4567
4465
|
#
|
4568
4466
|
# @option params [String] :location
|
4569
|
-
# A fleet location to get game
|
4570
|
-
# home Region or a remote location. Use the Amazon Web Services
|
4571
|
-
# code format, such as `us-west-2`.
|
4467
|
+
# A fleet location to get game session details for. You can specify a
|
4468
|
+
# fleet's home Region or a remote location. Use the Amazon Web Services
|
4469
|
+
# Region code format, such as `us-west-2`.
|
4572
4470
|
#
|
4573
4471
|
# @option params [String] :status_filter
|
4574
4472
|
# Game session status to filter results on. Possible game session
|
@@ -4653,20 +4551,6 @@ module Aws::GameLift
|
|
4653
4551
|
# `DescribeGameSessionPlacement` should only be used for games in
|
4654
4552
|
# development with low game session usage.
|
4655
4553
|
#
|
4656
|
-
# If successful, a GameSessionPlacement object is returned.
|
4657
|
-
#
|
4658
|
-
# **Related actions**
|
4659
|
-
#
|
4660
|
-
# CreateGameSession \| DescribeGameSessions \|
|
4661
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
4662
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
4663
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
4664
|
-
# by task][1]
|
4665
|
-
#
|
4666
|
-
#
|
4667
|
-
#
|
4668
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
4669
|
-
#
|
4670
4554
|
# @option params [required, String] :placement_id
|
4671
4555
|
# A unique identifier for a game session placement to retrieve.
|
4672
4556
|
#
|
@@ -4719,29 +4603,17 @@ module Aws::GameLift
|
|
4719
4603
|
|
4720
4604
|
# Retrieves the properties for one or more game session queues. When
|
4721
4605
|
# requesting multiple queues, use the pagination parameters to retrieve
|
4722
|
-
# results as a set of sequential pages.
|
4723
|
-
#
|
4724
|
-
#
|
4725
|
-
# currently exist in the Region.
|
4606
|
+
# results as a set of sequential pages. When specifying a list of
|
4607
|
+
# queues, objects are returned only for queues that currently exist in
|
4608
|
+
# the Region.
|
4726
4609
|
#
|
4727
4610
|
# **Learn more**
|
4728
4611
|
#
|
4729
4612
|
# [ View Your Queues][1]
|
4730
4613
|
#
|
4731
|
-
# **Related actions**
|
4732
|
-
#
|
4733
|
-
# [CreateGameSessionQueue][2] \| [DescribeGameSessionQueues][3] \|
|
4734
|
-
# [UpdateGameSessionQueue][4] \| [DeleteGameSessionQueue][5] \| [All
|
4735
|
-
# APIs by task][6]
|
4736
|
-
#
|
4737
4614
|
#
|
4738
4615
|
#
|
4739
4616
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html
|
4740
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
4741
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
4742
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
4743
|
-
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
4744
|
-
# [6]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
4745
4617
|
#
|
4746
4618
|
# @option params [Array<String>] :names
|
4747
4619
|
# A list of queue names to retrieve information for. You can use either
|
@@ -4806,18 +4678,7 @@ module Aws::GameLift
|
|
4806
4678
|
|
4807
4679
|
# Retrieves a set of one or more game sessions in a specific fleet
|
4808
4680
|
# location. You can optionally filter the results by current game
|
4809
|
-
# session status.
|
4810
|
-
# of active game sessions that are filtered by certain criteria. To
|
4811
|
-
# retrieve the protection policy for game sessions, use
|
4812
|
-
# DescribeGameSessionDetails.
|
4813
|
-
#
|
4814
|
-
# This operation is not designed to be continually called to track game
|
4815
|
-
# session status. This practice can cause you to exceed your API limit,
|
4816
|
-
# which results in errors. Instead, you must configure configure an
|
4817
|
-
# Amazon Simple Notification Service (SNS) topic to receive
|
4818
|
-
# notifications from FlexMatch or queues. Continuously polling with
|
4819
|
-
# `DescribeGameSessions` should only be used for games in development
|
4820
|
-
# with low game session usage.
|
4681
|
+
# session status.
|
4821
4682
|
#
|
4822
4683
|
# This operation can be used in the following ways:
|
4823
4684
|
#
|
@@ -4841,13 +4702,13 @@ module Aws::GameLift
|
|
4841
4702
|
# If successful, a `GameSession` object is returned for each game
|
4842
4703
|
# session that matches the request.
|
4843
4704
|
#
|
4844
|
-
# This operation is not designed to be continually called to track
|
4845
|
-
#
|
4846
|
-
#
|
4847
|
-
#
|
4848
|
-
#
|
4849
|
-
#
|
4850
|
-
#
|
4705
|
+
# This operation is not designed to be continually called to track game
|
4706
|
+
# session status. This practice can cause you to exceed your API limit,
|
4707
|
+
# which results in errors. Instead, you must configure an Amazon Simple
|
4708
|
+
# Notification Service (SNS) topic to receive notifications from
|
4709
|
+
# FlexMatch or queues. Continuously polling with `DescribeGameSessions`
|
4710
|
+
# should only be used for games in development with low game session
|
4711
|
+
# usage.
|
4851
4712
|
#
|
4852
4713
|
# *Available in Amazon GameLift Local.*
|
4853
4714
|
#
|
@@ -4855,13 +4716,7 @@ module Aws::GameLift
|
|
4855
4716
|
#
|
4856
4717
|
# [Find a game session][1]
|
4857
4718
|
#
|
4858
|
-
#
|
4859
|
-
#
|
4860
|
-
# CreateGameSession \| DescribeGameSessions \|
|
4861
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
4862
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
4863
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
4864
|
-
# by task][2]
|
4719
|
+
# [All APIs by task][2]
|
4865
4720
|
#
|
4866
4721
|
#
|
4867
4722
|
#
|
@@ -4881,9 +4736,9 @@ module Aws::GameLift
|
|
4881
4736
|
# value.
|
4882
4737
|
#
|
4883
4738
|
# @option params [String] :location
|
4884
|
-
# A fleet location to get game
|
4885
|
-
#
|
4886
|
-
#
|
4739
|
+
# A fleet location to get game sessions for. You can specify a fleet's
|
4740
|
+
# home Region or a remote location. Use the Amazon Web Services Region
|
4741
|
+
# code format, such as `us-west-2`.
|
4887
4742
|
#
|
4888
4743
|
# @option params [String] :status_filter
|
4889
4744
|
# Game session status to filter results on. You can filter on the
|
@@ -4983,7 +4838,6 @@ module Aws::GameLift
|
|
4983
4838
|
#
|
4984
4839
|
# **Related actions**
|
4985
4840
|
#
|
4986
|
-
# DescribeInstances \| GetInstanceAccess \| DescribeEC2InstanceLimits \|
|
4987
4841
|
# [All APIs by task][3]
|
4988
4842
|
#
|
4989
4843
|
#
|
@@ -5067,9 +4921,7 @@ module Aws::GameLift
|
|
5067
4921
|
# matchmaking ticket status. This practice can cause you to exceed your
|
5068
4922
|
# API limit, which results in errors. Instead, as a best practice, set
|
5069
4923
|
# up an Amazon Simple Notification Service to receive notifications, and
|
5070
|
-
# provide the topic ARN in the matchmaking configuration.
|
5071
|
-
# polling ticket status with DescribeMatchmaking should only be used for
|
5072
|
-
# games in development with low matchmaking usage.
|
4924
|
+
# provide the topic ARN in the matchmaking configuration.
|
5073
4925
|
#
|
5074
4926
|
#
|
5075
4927
|
#
|
@@ -5079,16 +4931,10 @@ module Aws::GameLift
|
|
5079
4931
|
#
|
5080
4932
|
# [ Set Up FlexMatch event notification][2]
|
5081
4933
|
#
|
5082
|
-
# **Related actions**
|
5083
|
-
#
|
5084
|
-
# StartMatchmaking \| DescribeMatchmaking \| StopMatchmaking \|
|
5085
|
-
# AcceptMatch \| StartMatchBackfill \| [All APIs by task][3]
|
5086
|
-
#
|
5087
4934
|
#
|
5088
4935
|
#
|
5089
4936
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
5090
4937
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
5091
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
5092
4938
|
#
|
5093
4939
|
# @option params [required, Array<String>] :ticket_ids
|
5094
4940
|
# A unique identifier for a matchmaking ticket. You can include up to 10
|
@@ -5157,18 +5003,9 @@ module Aws::GameLift
|
|
5157
5003
|
#
|
5158
5004
|
# [ Setting up FlexMatch matchmakers][1]
|
5159
5005
|
#
|
5160
|
-
# **Related actions**
|
5161
|
-
#
|
5162
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
5163
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
5164
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
5165
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
5166
|
-
# task][2]
|
5167
|
-
#
|
5168
5006
|
#
|
5169
5007
|
#
|
5170
5008
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html
|
5171
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
5172
5009
|
#
|
5173
5010
|
# @option params [Array<String>] :names
|
5174
5011
|
# A unique identifier for the matchmaking configuration(s) to retrieve.
|
@@ -5253,18 +5090,9 @@ module Aws::GameLift
|
|
5253
5090
|
#
|
5254
5091
|
# ^
|
5255
5092
|
#
|
5256
|
-
# **Related actions**
|
5257
|
-
#
|
5258
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
5259
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
5260
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
5261
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
5262
|
-
# task][2]
|
5263
|
-
#
|
5264
5093
|
#
|
5265
5094
|
#
|
5266
5095
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
5267
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
5268
5096
|
#
|
5269
5097
|
# @option params [Array<String>] :names
|
5270
5098
|
# A list of one or more matchmaking rule set names to retrieve details
|
@@ -5336,13 +5164,9 @@ module Aws::GameLift
|
|
5336
5164
|
# If successful, a `PlayerSession` object is returned for each session
|
5337
5165
|
# that matches the request.
|
5338
5166
|
#
|
5339
|
-
# *Available in Amazon GameLift Local.*
|
5340
|
-
#
|
5341
5167
|
# **Related actions**
|
5342
5168
|
#
|
5343
|
-
#
|
5344
|
-
# \| StartGameSessionPlacement \| DescribeGameSessionPlacement \| [All
|
5345
|
-
# APIs by task][1]
|
5169
|
+
# [All APIs by task][1]
|
5346
5170
|
#
|
5347
5171
|
#
|
5348
5172
|
#
|
@@ -5359,7 +5183,10 @@ module Aws::GameLift
|
|
5359
5183
|
# A unique identifier for a player session to retrieve.
|
5360
5184
|
#
|
5361
5185
|
# @option params [String] :player_session_status_filter
|
5362
|
-
# Player session status to filter results on.
|
5186
|
+
# Player session status to filter results on. Note that when a
|
5187
|
+
# PlayerSessionId or PlayerId is provided in a DescribePlayerSessions
|
5188
|
+
# request, then the PlayerSessionStatusFilter has no effect on the
|
5189
|
+
# response.
|
5363
5190
|
#
|
5364
5191
|
# Possible player session statuses include the following:
|
5365
5192
|
#
|
@@ -5439,7 +5266,7 @@ module Aws::GameLift
|
|
5439
5266
|
# To get the runtime configuration that is currently in forces for a
|
5440
5267
|
# fleet, provide the fleet ID.
|
5441
5268
|
#
|
5442
|
-
# If successful, a RuntimeConfiguration object is returned for the
|
5269
|
+
# If successful, a `RuntimeConfiguration` object is returned for the
|
5443
5270
|
# requested fleet. If the requested fleet has been deleted, the result
|
5444
5271
|
# set is empty.
|
5445
5272
|
#
|
@@ -5449,19 +5276,10 @@ module Aws::GameLift
|
|
5449
5276
|
#
|
5450
5277
|
# [Running multiple processes on a fleet][2]
|
5451
5278
|
#
|
5452
|
-
# **Related actions**
|
5453
|
-
#
|
5454
|
-
# ListFleets \| DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
5455
|
-
# DescribeFleetCapacity \| DescribeFleetEvents \|
|
5456
|
-
# DescribeFleetLocationAttributes \| DescribeFleetPortSettings \|
|
5457
|
-
# DescribeFleetUtilization \| DescribeRuntimeConfiguration \|
|
5458
|
-
# DescribeScalingPolicies \| [All APIs by task][3]
|
5459
|
-
#
|
5460
5279
|
#
|
5461
5280
|
#
|
5462
5281
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
5463
5282
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html
|
5464
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
5465
5283
|
#
|
5466
5284
|
# @option params [required, String] :fleet_id
|
5467
5285
|
# A unique identifier for the fleet to get the runtime configuration
|
@@ -5500,25 +5318,12 @@ module Aws::GameLift
|
|
5500
5318
|
# To get a fleet's scaling policies, specify the fleet ID. You can
|
5501
5319
|
# filter this request by policy status, such as to retrieve only active
|
5502
5320
|
# scaling policies. Use the pagination parameters to retrieve results as
|
5503
|
-
# a set of sequential pages. If successful, set of ScalingPolicy
|
5504
|
-
# is returned for the fleet.
|
5505
|
-
#
|
5506
|
-
# A fleet may have all of its scaling policies suspended
|
5507
|
-
# (StopFleetActions). This operation does not affect the status of the
|
5508
|
-
# scaling policies, which remains ACTIVE. To see whether a fleet's
|
5509
|
-
# scaling policies are in force or suspended, call
|
5510
|
-
# DescribeFleetAttributes and check the stopped actions.
|
5511
|
-
#
|
5512
|
-
# **Related actions**
|
5513
|
-
#
|
5514
|
-
# DescribeFleetCapacity \| UpdateFleetCapacity \|
|
5515
|
-
# DescribeEC2InstanceLimits \| PutScalingPolicy \|
|
5516
|
-
# DescribeScalingPolicies \| DeleteScalingPolicy \| StopFleetActions \|
|
5517
|
-
# StartFleetActions \| [All APIs by task][1]
|
5518
|
-
#
|
5321
|
+
# a set of sequential pages. If successful, set of `ScalingPolicy`
|
5322
|
+
# objects is returned for the fleet.
|
5519
5323
|
#
|
5520
|
-
#
|
5521
|
-
#
|
5324
|
+
# A fleet may have all of its scaling policies suspended. This operation
|
5325
|
+
# does not affect the status of the scaling policies, which remains
|
5326
|
+
# ACTIVE.
|
5522
5327
|
#
|
5523
5328
|
# @option params [required, String] :fleet_id
|
5524
5329
|
# A unique identifier for the fleet for which to retrieve scaling
|
@@ -5588,7 +5393,7 @@ module Aws::GameLift
|
|
5588
5393
|
# resp.scaling_policies[0].comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
|
5589
5394
|
# resp.scaling_policies[0].threshold #=> Float
|
5590
5395
|
# resp.scaling_policies[0].evaluation_periods #=> Integer
|
5591
|
-
# resp.scaling_policies[0].metric_name #=> String, one of "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailableGameSessions", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances", "PercentAvailableGameSessions", "PercentIdleInstances", "QueueDepth", "WaitTime"
|
5396
|
+
# resp.scaling_policies[0].metric_name #=> String, one of "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailableGameSessions", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances", "PercentAvailableGameSessions", "PercentIdleInstances", "QueueDepth", "WaitTime", "ConcurrentActivatableGameSessions"
|
5592
5397
|
# resp.scaling_policies[0].policy_type #=> String, one of "RuleBased", "TargetBased"
|
5593
5398
|
# resp.scaling_policies[0].target_configuration.target_value #=> Float
|
5594
5399
|
# resp.scaling_policies[0].update_status #=> String, one of "PENDING_UPDATE"
|
@@ -5615,8 +5420,7 @@ module Aws::GameLift
|
|
5615
5420
|
#
|
5616
5421
|
# **Related actions**
|
5617
5422
|
#
|
5618
|
-
#
|
5619
|
-
# DeleteScript \| [All APIs by task][2]
|
5423
|
+
# [All APIs by task][2]
|
5620
5424
|
#
|
5621
5425
|
#
|
5622
5426
|
#
|
@@ -5666,10 +5470,7 @@ module Aws::GameLift
|
|
5666
5470
|
#
|
5667
5471
|
# **Related actions**
|
5668
5472
|
#
|
5669
|
-
#
|
5670
|
-
# DeleteVpcPeeringAuthorization \| CreateVpcPeeringConnection \|
|
5671
|
-
# DescribeVpcPeeringConnections \| DeleteVpcPeeringConnection \| [All
|
5672
|
-
# APIs by task][1]
|
5473
|
+
# [All APIs by task][1]
|
5673
5474
|
#
|
5674
5475
|
#
|
5675
5476
|
#
|
@@ -5710,10 +5511,7 @@ module Aws::GameLift
|
|
5710
5511
|
#
|
5711
5512
|
# **Related actions**
|
5712
5513
|
#
|
5713
|
-
#
|
5714
|
-
# DeleteVpcPeeringAuthorization \| CreateVpcPeeringConnection \|
|
5715
|
-
# DescribeVpcPeeringConnections \| DeleteVpcPeeringConnection \| [All
|
5716
|
-
# APIs by task][1]
|
5514
|
+
# [All APIs by task][1]
|
5717
5515
|
#
|
5718
5516
|
#
|
5719
5517
|
#
|
@@ -5754,6 +5552,122 @@ module Aws::GameLift
|
|
5754
5552
|
req.send_request(options)
|
5755
5553
|
end
|
5756
5554
|
|
5555
|
+
# Requests remote access to a fleet instance. Remote access is useful
|
5556
|
+
# for debugging, gathering benchmarking data, or observing activity in
|
5557
|
+
# real time.
|
5558
|
+
#
|
5559
|
+
# To remotely access an instance, you need credentials that match the
|
5560
|
+
# operating system of the instance. For a Windows instance, GameLift
|
5561
|
+
# returns a user name and password as strings for use with a Windows
|
5562
|
+
# Remote Desktop client. For a Linux instance, GameLift returns a user
|
5563
|
+
# name and RSA private key, also as strings, for use with an SSH client.
|
5564
|
+
# The private key must be saved in the proper format to a `.pem` file
|
5565
|
+
# before using. If you're making this request using the CLI, saving the
|
5566
|
+
# secret can be handled as part of the `GetInstanceAccess` request, as
|
5567
|
+
# shown in one of the examples for this operation.
|
5568
|
+
#
|
5569
|
+
# To request access to a specific instance, specify the IDs of both the
|
5570
|
+
# instance and the fleet it belongs to.
|
5571
|
+
#
|
5572
|
+
# **Learn more**
|
5573
|
+
#
|
5574
|
+
# [Remotely Access Fleet Instances][1]
|
5575
|
+
#
|
5576
|
+
# [Debug Fleet Issues][2]
|
5577
|
+
#
|
5578
|
+
#
|
5579
|
+
#
|
5580
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
5581
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
5582
|
+
#
|
5583
|
+
# @option params [required, String] :fleet_id
|
5584
|
+
# A unique identifier for the fleet that the compute resource is
|
5585
|
+
# registered to.
|
5586
|
+
#
|
5587
|
+
# @option params [required, String] :compute_name
|
5588
|
+
# The name of the compute resource you are requesting credentials for.
|
5589
|
+
#
|
5590
|
+
# @return [Types::GetComputeAccessOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5591
|
+
#
|
5592
|
+
# * {Types::GetComputeAccessOutput#fleet_id #fleet_id} => String
|
5593
|
+
# * {Types::GetComputeAccessOutput#fleet_arn #fleet_arn} => String
|
5594
|
+
# * {Types::GetComputeAccessOutput#compute_name #compute_name} => String
|
5595
|
+
# * {Types::GetComputeAccessOutput#compute_arn #compute_arn} => String
|
5596
|
+
# * {Types::GetComputeAccessOutput#credentials #credentials} => Types::AwsCredentials
|
5597
|
+
#
|
5598
|
+
# @example Request syntax with placeholder values
|
5599
|
+
#
|
5600
|
+
# resp = client.get_compute_access({
|
5601
|
+
# fleet_id: "FleetIdOrArn", # required
|
5602
|
+
# compute_name: "ComputeNameOrArn", # required
|
5603
|
+
# })
|
5604
|
+
#
|
5605
|
+
# @example Response structure
|
5606
|
+
#
|
5607
|
+
# resp.fleet_id #=> String
|
5608
|
+
# resp.fleet_arn #=> String
|
5609
|
+
# resp.compute_name #=> String
|
5610
|
+
# resp.compute_arn #=> String
|
5611
|
+
# resp.credentials.access_key_id #=> String
|
5612
|
+
# resp.credentials.secret_access_key #=> String
|
5613
|
+
# resp.credentials.session_token #=> String
|
5614
|
+
#
|
5615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAccess AWS API Documentation
|
5616
|
+
#
|
5617
|
+
# @overload get_compute_access(params = {})
|
5618
|
+
# @param [Hash] params ({})
|
5619
|
+
def get_compute_access(params = {}, options = {})
|
5620
|
+
req = build_request(:get_compute_access, params)
|
5621
|
+
req.send_request(options)
|
5622
|
+
end
|
5623
|
+
|
5624
|
+
# Requests an authorization token from GameLift. The authorization token
|
5625
|
+
# is used by your game server to authenticate with GameLift. Each
|
5626
|
+
# authentication token has an expiration token. To continue using the
|
5627
|
+
# compute resource to host your game server, regularly retrieve a new
|
5628
|
+
# authorization token.
|
5629
|
+
#
|
5630
|
+
# @option params [required, String] :fleet_id
|
5631
|
+
# A unique identifier for the fleet that the compute is registered to.
|
5632
|
+
#
|
5633
|
+
# @option params [required, String] :compute_name
|
5634
|
+
# The name of the compute resource you are requesting the authorization
|
5635
|
+
# token for.
|
5636
|
+
#
|
5637
|
+
# @return [Types::GetComputeAuthTokenOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5638
|
+
#
|
5639
|
+
# * {Types::GetComputeAuthTokenOutput#fleet_id #fleet_id} => String
|
5640
|
+
# * {Types::GetComputeAuthTokenOutput#fleet_arn #fleet_arn} => String
|
5641
|
+
# * {Types::GetComputeAuthTokenOutput#compute_name #compute_name} => String
|
5642
|
+
# * {Types::GetComputeAuthTokenOutput#compute_arn #compute_arn} => String
|
5643
|
+
# * {Types::GetComputeAuthTokenOutput#auth_token #auth_token} => String
|
5644
|
+
# * {Types::GetComputeAuthTokenOutput#expiration_timestamp #expiration_timestamp} => Time
|
5645
|
+
#
|
5646
|
+
# @example Request syntax with placeholder values
|
5647
|
+
#
|
5648
|
+
# resp = client.get_compute_auth_token({
|
5649
|
+
# fleet_id: "FleetIdOrArn", # required
|
5650
|
+
# compute_name: "ComputeNameOrArn", # required
|
5651
|
+
# })
|
5652
|
+
#
|
5653
|
+
# @example Response structure
|
5654
|
+
#
|
5655
|
+
# resp.fleet_id #=> String
|
5656
|
+
# resp.fleet_arn #=> String
|
5657
|
+
# resp.compute_name #=> String
|
5658
|
+
# resp.compute_arn #=> String
|
5659
|
+
# resp.auth_token #=> String
|
5660
|
+
# resp.expiration_timestamp #=> Time
|
5661
|
+
#
|
5662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthToken AWS API Documentation
|
5663
|
+
#
|
5664
|
+
# @overload get_compute_auth_token(params = {})
|
5665
|
+
# @param [Hash] params ({})
|
5666
|
+
def get_compute_auth_token(params = {}, options = {})
|
5667
|
+
req = build_request(:get_compute_auth_token, params)
|
5668
|
+
req.send_request(options)
|
5669
|
+
end
|
5670
|
+
|
5757
5671
|
# Retrieves the location of stored game session logs for a specified
|
5758
5672
|
# game session. When a game session is terminated, GameLift
|
5759
5673
|
# automatically stores the logs in Amazon S3 and retains them for 14
|
@@ -5764,13 +5678,7 @@ module Aws::GameLift
|
|
5764
5678
|
#
|
5765
5679
|
# </note>
|
5766
5680
|
#
|
5767
|
-
#
|
5768
|
-
#
|
5769
|
-
# CreateGameSession \| DescribeGameSessions \|
|
5770
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
5771
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
5772
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
5773
|
-
# by task][2]
|
5681
|
+
# [All APIs by task][2]
|
5774
5682
|
#
|
5775
5683
|
#
|
5776
5684
|
#
|
@@ -5819,26 +5727,24 @@ module Aws::GameLift
|
|
5819
5727
|
#
|
5820
5728
|
# To request access to a specific instance, specify the IDs of both the
|
5821
5729
|
# instance and the fleet it belongs to. You can retrieve a fleet's
|
5822
|
-
# instance IDs by calling DescribeInstances.
|
5823
|
-
# InstanceAccess object is returned that contains the instance's IP
|
5824
|
-
# address and a set of credentials.
|
5730
|
+
# instance IDs by calling [DescribeInstances][1].
|
5825
5731
|
#
|
5826
5732
|
# **Learn more**
|
5827
5733
|
#
|
5828
|
-
# [Remotely Access Fleet Instances][
|
5734
|
+
# [Remotely Access Fleet Instances][2]
|
5829
5735
|
#
|
5830
|
-
# [Debug Fleet Issues][
|
5736
|
+
# [Debug Fleet Issues][3]
|
5831
5737
|
#
|
5832
5738
|
# **Related actions**
|
5833
5739
|
#
|
5834
|
-
#
|
5835
|
-
# [All APIs by task][3]
|
5740
|
+
# [All APIs by task][4]
|
5836
5741
|
#
|
5837
5742
|
#
|
5838
5743
|
#
|
5839
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
5840
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-
|
5841
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
5744
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html
|
5745
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
5746
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
5747
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
5842
5748
|
#
|
5843
5749
|
# @option params [required, String] :fleet_id
|
5844
5750
|
# A unique identifier for the fleet that contains the instance you want
|
@@ -5890,8 +5796,7 @@ module Aws::GameLift
|
|
5890
5796
|
#
|
5891
5797
|
# **Related actions**
|
5892
5798
|
#
|
5893
|
-
#
|
5894
|
-
# DeleteAlias \| ResolveAlias \| [All APIs by task][1]
|
5799
|
+
# [All APIs by task][1]
|
5895
5800
|
#
|
5896
5801
|
#
|
5897
5802
|
#
|
@@ -5909,8 +5814,12 @@ module Aws::GameLift
|
|
5909
5814
|
#
|
5910
5815
|
# * **TERMINAL** -- The alias does not resolve to a fleet but instead
|
5911
5816
|
# can be used to display a message to the user. A terminal alias
|
5912
|
-
# throws a TerminalRoutingStrategyException with the
|
5913
|
-
# message embedded.
|
5817
|
+
# throws a TerminalRoutingStrategyException with the
|
5818
|
+
# [RoutingStrategy][1] message embedded.
|
5819
|
+
#
|
5820
|
+
#
|
5821
|
+
#
|
5822
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html
|
5914
5823
|
#
|
5915
5824
|
# @option params [String] :name
|
5916
5825
|
# A descriptive label that is associated with an alias. Alias names do
|
@@ -5979,10 +5888,7 @@ module Aws::GameLift
|
|
5979
5888
|
#
|
5980
5889
|
# [ Upload a Custom Server Build][1]
|
5981
5890
|
#
|
5982
|
-
#
|
5983
|
-
#
|
5984
|
-
# CreateBuild \| ListBuilds \| DescribeBuild \| UpdateBuild \|
|
5985
|
-
# DeleteBuild \| [All APIs by task][2]
|
5891
|
+
# [All APIs by task][2]
|
5986
5892
|
#
|
5987
5893
|
#
|
5988
5894
|
#
|
@@ -6042,6 +5948,7 @@ module Aws::GameLift
|
|
6042
5948
|
# resp.builds[0].size_on_disk #=> Integer
|
6043
5949
|
# resp.builds[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
6044
5950
|
# resp.builds[0].creation_time #=> Time
|
5951
|
+
# resp.builds[0].server_sdk_version #=> String
|
6045
5952
|
# resp.next_token #=> String
|
6046
5953
|
#
|
6047
5954
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuilds AWS API Documentation
|
@@ -6053,6 +5960,69 @@ module Aws::GameLift
|
|
6053
5960
|
req.send_request(options)
|
6054
5961
|
end
|
6055
5962
|
|
5963
|
+
# Retrieves all compute resources registered to a fleet in your Amazon
|
5964
|
+
# Web Services account. You can filter the result set by location.
|
5965
|
+
#
|
5966
|
+
# @option params [required, String] :fleet_id
|
5967
|
+
# A unique identifier for the fleet the compute resources are registered
|
5968
|
+
# to.
|
5969
|
+
#
|
5970
|
+
# @option params [String] :location
|
5971
|
+
# The name of the custom location that the compute resources are
|
5972
|
+
# assigned to.
|
5973
|
+
#
|
5974
|
+
# @option params [Integer] :limit
|
5975
|
+
# The maximum number of results to return. Use this parameter with
|
5976
|
+
# `NextToken` to get results as a set of sequential pages.
|
5977
|
+
#
|
5978
|
+
# @option params [String] :next_token
|
5979
|
+
# A token that indicates the start of the next sequential page of
|
5980
|
+
# results. Use the token that is returned with a previous call to this
|
5981
|
+
# operation. To start at the beginning of the result set, do not specify
|
5982
|
+
# a value.
|
5983
|
+
#
|
5984
|
+
# @return [Types::ListComputeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5985
|
+
#
|
5986
|
+
# * {Types::ListComputeOutput#compute_list #compute_list} => Array<Types::Compute>
|
5987
|
+
# * {Types::ListComputeOutput#next_token #next_token} => String
|
5988
|
+
#
|
5989
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5990
|
+
#
|
5991
|
+
# @example Request syntax with placeholder values
|
5992
|
+
#
|
5993
|
+
# resp = client.list_compute({
|
5994
|
+
# fleet_id: "FleetIdOrArn", # required
|
5995
|
+
# location: "LocationStringModel",
|
5996
|
+
# limit: 1,
|
5997
|
+
# next_token: "NonZeroAndMaxString",
|
5998
|
+
# })
|
5999
|
+
#
|
6000
|
+
# @example Response structure
|
6001
|
+
#
|
6002
|
+
# resp.compute_list #=> Array
|
6003
|
+
# resp.compute_list[0].fleet_id #=> String
|
6004
|
+
# resp.compute_list[0].fleet_arn #=> String
|
6005
|
+
# resp.compute_list[0].compute_name #=> String
|
6006
|
+
# resp.compute_list[0].compute_arn #=> String
|
6007
|
+
# resp.compute_list[0].ip_address #=> String
|
6008
|
+
# resp.compute_list[0].dns_name #=> String
|
6009
|
+
# resp.compute_list[0].compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
6010
|
+
# resp.compute_list[0].location #=> String
|
6011
|
+
# resp.compute_list[0].creation_time #=> Time
|
6012
|
+
# resp.compute_list[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
6013
|
+
# resp.compute_list[0].type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge"
|
6014
|
+
# resp.compute_list[0].game_lift_service_sdk_endpoint #=> String
|
6015
|
+
# resp.next_token #=> String
|
6016
|
+
#
|
6017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListCompute AWS API Documentation
|
6018
|
+
#
|
6019
|
+
# @overload list_compute(params = {})
|
6020
|
+
# @param [Hash] params ({})
|
6021
|
+
def list_compute(params = {}, options = {})
|
6022
|
+
req = build_request(:list_compute, params)
|
6023
|
+
req.send_request(options)
|
6024
|
+
end
|
6025
|
+
|
6056
6026
|
# Retrieves a collection of fleet resources in an Amazon Web Services
|
6057
6027
|
# Region. You can call this operation to get fleets in a previously
|
6058
6028
|
# selected default Region (see
|
@@ -6088,18 +6058,10 @@ module Aws::GameLift
|
|
6088
6058
|
#
|
6089
6059
|
# [Setting up GameLift fleets][2]
|
6090
6060
|
#
|
6091
|
-
# **Related actions**
|
6092
|
-
#
|
6093
|
-
# CreateFleet \| UpdateFleetCapacity \| PutScalingPolicy \|
|
6094
|
-
# DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
6095
|
-
# DescribeFleetLocationAttributes \| UpdateFleetAttributes \|
|
6096
|
-
# StopFleetActions \| DeleteFleet \| [All APIs by task][3]
|
6097
|
-
#
|
6098
6061
|
#
|
6099
6062
|
#
|
6100
6063
|
# [1]: https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html
|
6101
6064
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
6102
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
6103
6065
|
#
|
6104
6066
|
# @option params [String] :build_id
|
6105
6067
|
# A unique identifier for the build to request fleets for. Use this
|
@@ -6152,40 +6114,14 @@ module Aws::GameLift
|
|
6152
6114
|
req.send_request(options)
|
6153
6115
|
end
|
6154
6116
|
|
6155
|
-
#
|
6156
|
-
# server groups.**
|
6157
|
-
#
|
6158
|
-
# Retrieves information on all game servers groups that exist in the
|
6159
|
-
# current Amazon Web Services account for the selected Region. Use the
|
6160
|
-
# pagination parameters to retrieve results in a set of sequential
|
6161
|
-
# segments.
|
6162
|
-
#
|
6163
|
-
# **Learn more**
|
6164
|
-
#
|
6165
|
-
# [GameLift FleetIQ Guide][1]
|
6166
|
-
#
|
6167
|
-
# **Related actions**
|
6168
|
-
#
|
6169
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
6170
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
6171
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
6172
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
6173
|
-
# task][2]
|
6174
|
-
#
|
6175
|
-
#
|
6176
|
-
#
|
6177
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6178
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
6117
|
+
# Lists a game server groups.
|
6179
6118
|
#
|
6180
6119
|
# @option params [Integer] :limit
|
6181
|
-
# The
|
6182
|
-
# `NextToken` to get results as a set of sequential pages.
|
6120
|
+
# The game server groups' limit.
|
6183
6121
|
#
|
6184
6122
|
# @option params [String] :next_token
|
6185
|
-
#
|
6186
|
-
#
|
6187
|
-
# operation. To start at the beginning of the result set, do not specify
|
6188
|
-
# a value.
|
6123
|
+
# Specify the pagination token from a previous request to retrieve the
|
6124
|
+
# next page of results.
|
6189
6125
|
#
|
6190
6126
|
# @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6191
6127
|
#
|
@@ -6242,20 +6178,13 @@ module Aws::GameLift
|
|
6242
6178
|
#
|
6243
6179
|
# [GameLift FleetIQ Guide][1]
|
6244
6180
|
#
|
6245
|
-
# **Related actions**
|
6246
|
-
#
|
6247
|
-
# RegisterGameServer \| ListGameServers \| ClaimGameServer \|
|
6248
|
-
# DescribeGameServer \| UpdateGameServer \| DeregisterGameServer \| [All
|
6249
|
-
# APIs by task][2]
|
6250
|
-
#
|
6251
6181
|
#
|
6252
6182
|
#
|
6253
6183
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6254
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
6255
6184
|
#
|
6256
6185
|
# @option params [required, String] :game_server_group_name
|
6257
6186
|
# An identifier for the game server group to retrieve a list of game
|
6258
|
-
# servers from. Use either the
|
6187
|
+
# servers from. Use either the name or ARN value.
|
6259
6188
|
#
|
6260
6189
|
# @option params [String] :sort_order
|
6261
6190
|
# Indicates how to sort the returned data based on game server
|
@@ -6315,6 +6244,52 @@ module Aws::GameLift
|
|
6315
6244
|
req.send_request(options)
|
6316
6245
|
end
|
6317
6246
|
|
6247
|
+
# Lists all custom and Amazon Web Services locations.
|
6248
|
+
#
|
6249
|
+
# @option params [Array<String>] :filters
|
6250
|
+
# Filters the list for `AWS` or `CUSTOM` locations.
|
6251
|
+
#
|
6252
|
+
# @option params [Integer] :limit
|
6253
|
+
# The maximum number of results to return. Use this parameter with
|
6254
|
+
# `NextToken` to get results as a set of sequential pages.
|
6255
|
+
#
|
6256
|
+
# @option params [String] :next_token
|
6257
|
+
# A token that indicates the start of the next sequential page of
|
6258
|
+
# results. Use the token that is returned with a previous call to this
|
6259
|
+
# operation. To start at the beginning of the result set, do not specify
|
6260
|
+
# a value.
|
6261
|
+
#
|
6262
|
+
# @return [Types::ListLocationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6263
|
+
#
|
6264
|
+
# * {Types::ListLocationsOutput#locations #locations} => Array<Types::LocationModel>
|
6265
|
+
# * {Types::ListLocationsOutput#next_token #next_token} => String
|
6266
|
+
#
|
6267
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6268
|
+
#
|
6269
|
+
# @example Request syntax with placeholder values
|
6270
|
+
#
|
6271
|
+
# resp = client.list_locations({
|
6272
|
+
# filters: ["AWS"], # accepts AWS, CUSTOM
|
6273
|
+
# limit: 1,
|
6274
|
+
# next_token: "NonZeroAndMaxString",
|
6275
|
+
# })
|
6276
|
+
#
|
6277
|
+
# @example Response structure
|
6278
|
+
#
|
6279
|
+
# resp.locations #=> Array
|
6280
|
+
# resp.locations[0].location_name #=> String
|
6281
|
+
# resp.locations[0].location_arn #=> String
|
6282
|
+
# resp.next_token #=> String
|
6283
|
+
#
|
6284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListLocations AWS API Documentation
|
6285
|
+
#
|
6286
|
+
# @overload list_locations(params = {})
|
6287
|
+
# @param [Hash] params ({})
|
6288
|
+
def list_locations(params = {}, options = {})
|
6289
|
+
req = build_request(:list_locations, params)
|
6290
|
+
req.send_request(options)
|
6291
|
+
end
|
6292
|
+
|
6318
6293
|
# Retrieves script records for all Realtime scripts that are associated
|
6319
6294
|
# with the Amazon Web Services account in use.
|
6320
6295
|
#
|
@@ -6324,8 +6299,7 @@ module Aws::GameLift
|
|
6324
6299
|
#
|
6325
6300
|
# **Related actions**
|
6326
6301
|
#
|
6327
|
-
#
|
6328
|
-
# DeleteScript \| [All APIs by task][2]
|
6302
|
+
# [All APIs by task][2]
|
6329
6303
|
#
|
6330
6304
|
#
|
6331
6305
|
#
|
@@ -6411,8 +6385,7 @@ module Aws::GameLift
|
|
6411
6385
|
#
|
6412
6386
|
# **Related actions**
|
6413
6387
|
#
|
6414
|
-
#
|
6415
|
-
# task][3]
|
6388
|
+
# [All APIs by task][3]
|
6416
6389
|
#
|
6417
6390
|
#
|
6418
6391
|
#
|
@@ -6472,12 +6445,6 @@ module Aws::GameLift
|
|
6472
6445
|
# because multiple auto-scaling policies can have unintended
|
6473
6446
|
# consequences.
|
6474
6447
|
#
|
6475
|
-
# You can temporarily suspend all scaling policies for a fleet by
|
6476
|
-
# calling StopFleetActions with the fleet action AUTO\_SCALING. To
|
6477
|
-
# resume scaling policies, call StartFleetActions with the same fleet
|
6478
|
-
# action. To stop just one scaling policy--or to permanently remove it,
|
6479
|
-
# you must delete the policy with DeleteScalingPolicy.
|
6480
|
-
#
|
6481
6448
|
# Learn more about how to work with auto-scaling in [Set Up Fleet
|
6482
6449
|
# Automatic Scaling][1].
|
6483
6450
|
#
|
@@ -6502,8 +6469,8 @@ module Aws::GameLift
|
|
6502
6469
|
# To create or update a target-based policy, specify a fleet ID and
|
6503
6470
|
# name, and set the policy type to "TargetBased". Specify the metric
|
6504
6471
|
# to track (PercentAvailableGameSessions) and reference a
|
6505
|
-
# TargetConfiguration object with your desired buffer value. Exclude
|
6506
|
-
# other parameters. On a successful request, the policy name is
|
6472
|
+
# `TargetConfiguration` object with your desired buffer value. Exclude
|
6473
|
+
# all other parameters. On a successful request, the policy name is
|
6507
6474
|
# returned. The scaling policy is automatically in force as soon as
|
6508
6475
|
# it's successfully created. If the fleet's auto-scaling actions are
|
6509
6476
|
# temporarily suspended, the new policy will be in force once the fleet
|
@@ -6540,17 +6507,9 @@ module Aws::GameLift
|
|
6540
6507
|
# the fleet's auto-scaling actions are temporarily suspended, the new
|
6541
6508
|
# policy will be in force once the fleet actions are restarted.
|
6542
6509
|
#
|
6543
|
-
# **Related actions**
|
6544
|
-
#
|
6545
|
-
# DescribeFleetCapacity \| UpdateFleetCapacity \|
|
6546
|
-
# DescribeEC2InstanceLimits \| PutScalingPolicy \|
|
6547
|
-
# DescribeScalingPolicies \| DeleteScalingPolicy \| StopFleetActions \|
|
6548
|
-
# StartFleetActions \| [All APIs by task][2]
|
6549
|
-
#
|
6550
6510
|
#
|
6551
6511
|
#
|
6552
6512
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html
|
6553
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
6554
6513
|
#
|
6555
6514
|
# @option params [required, String] :name
|
6556
6515
|
# A descriptive label that is associated with a fleet's scaling policy.
|
@@ -6566,8 +6525,7 @@ module Aws::GameLift
|
|
6566
6525
|
# Amount of adjustment to make, based on the scaling adjustment type.
|
6567
6526
|
#
|
6568
6527
|
# @option params [String] :scaling_adjustment_type
|
6569
|
-
# The type of adjustment to make to a fleet's instance count
|
6570
|
-
# FleetCapacity):
|
6528
|
+
# The type of adjustment to make to a fleet's instance count:
|
6571
6529
|
#
|
6572
6530
|
# * **ChangeInCapacity** -- add (or subtract) the scaling adjustment
|
6573
6531
|
# value from the current instance count. Positive values scale up
|
@@ -6661,7 +6619,7 @@ module Aws::GameLift
|
|
6661
6619
|
# threshold: 1.0,
|
6662
6620
|
# comparison_operator: "GreaterThanOrEqualToThreshold", # accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
|
6663
6621
|
# evaluation_periods: 1,
|
6664
|
-
# metric_name: "ActivatingGameSessions", # required, accepts ActivatingGameSessions, ActiveGameSessions, ActiveInstances, AvailableGameSessions, AvailablePlayerSessions, CurrentPlayerSessions, IdleInstances, PercentAvailableGameSessions, PercentIdleInstances, QueueDepth, WaitTime
|
6622
|
+
# metric_name: "ActivatingGameSessions", # required, accepts ActivatingGameSessions, ActiveGameSessions, ActiveInstances, AvailableGameSessions, AvailablePlayerSessions, CurrentPlayerSessions, IdleInstances, PercentAvailableGameSessions, PercentIdleInstances, QueueDepth, WaitTime, ConcurrentActivatableGameSessions
|
6665
6623
|
# policy_type: "RuleBased", # accepts RuleBased, TargetBased
|
6666
6624
|
# target_configuration: {
|
6667
6625
|
# target_value: 1.0, # required
|
@@ -6681,6 +6639,86 @@ module Aws::GameLift
|
|
6681
6639
|
req.send_request(options)
|
6682
6640
|
end
|
6683
6641
|
|
6642
|
+
# Registers your compute resources in a fleet you previously created.
|
6643
|
+
# After you register a compute to your fleet, you can monitor and manage
|
6644
|
+
# your compute using GameLift. The operation returns the compute
|
6645
|
+
# resource containing SDK endpoint you can use to connect your game
|
6646
|
+
# server to GameLift.
|
6647
|
+
#
|
6648
|
+
# **Learn more**
|
6649
|
+
#
|
6650
|
+
# * [Create an Anywhere fleet][1]
|
6651
|
+
#
|
6652
|
+
# * [Test your integration][2]
|
6653
|
+
#
|
6654
|
+
#
|
6655
|
+
#
|
6656
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html
|
6657
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html
|
6658
|
+
#
|
6659
|
+
# @option params [required, String] :fleet_id
|
6660
|
+
# A unique identifier for the fleet to register the compute to. You can
|
6661
|
+
# use either the fleet ID or ARN value.
|
6662
|
+
#
|
6663
|
+
# @option params [required, String] :compute_name
|
6664
|
+
# A descriptive label that is associated with the compute resource
|
6665
|
+
# registered to your fleet.
|
6666
|
+
#
|
6667
|
+
# @option params [String] :certificate_path
|
6668
|
+
# The path to the TLS certificate on your compute resource. The path and
|
6669
|
+
# certificate are not validated by GameLift.
|
6670
|
+
#
|
6671
|
+
# @option params [String] :dns_name
|
6672
|
+
# The DNS name of the compute resource. GameLift requires the DNS name
|
6673
|
+
# or IP address to manage your compute resource.
|
6674
|
+
#
|
6675
|
+
# @option params [String] :ip_address
|
6676
|
+
# The IP address of the compute resource. GameLift requires the DNS name
|
6677
|
+
# or IP address to manage your compute resource.
|
6678
|
+
#
|
6679
|
+
# @option params [String] :location
|
6680
|
+
# The name of the custom location you added to the fleet you are
|
6681
|
+
# registering this compute resource to.
|
6682
|
+
#
|
6683
|
+
# @return [Types::RegisterComputeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6684
|
+
#
|
6685
|
+
# * {Types::RegisterComputeOutput#compute #compute} => Types::Compute
|
6686
|
+
#
|
6687
|
+
# @example Request syntax with placeholder values
|
6688
|
+
#
|
6689
|
+
# resp = client.register_compute({
|
6690
|
+
# fleet_id: "FleetIdOrArn", # required
|
6691
|
+
# compute_name: "ComputeName", # required
|
6692
|
+
# certificate_path: "NonZeroAndMaxString",
|
6693
|
+
# dns_name: "DnsNameInput",
|
6694
|
+
# ip_address: "IpAddress",
|
6695
|
+
# location: "LocationStringModel",
|
6696
|
+
# })
|
6697
|
+
#
|
6698
|
+
# @example Response structure
|
6699
|
+
#
|
6700
|
+
# resp.compute.fleet_id #=> String
|
6701
|
+
# resp.compute.fleet_arn #=> String
|
6702
|
+
# resp.compute.compute_name #=> String
|
6703
|
+
# resp.compute.compute_arn #=> String
|
6704
|
+
# resp.compute.ip_address #=> String
|
6705
|
+
# resp.compute.dns_name #=> String
|
6706
|
+
# resp.compute.compute_status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
6707
|
+
# resp.compute.location #=> String
|
6708
|
+
# resp.compute.creation_time #=> Time
|
6709
|
+
# resp.compute.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
6710
|
+
# resp.compute.type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge", "c5d.large", "c5d.xlarge", "c5d.2xlarge", "c5d.4xlarge", "c5d.9xlarge", "c5d.12xlarge", "c5d.18xlarge", "c5d.24xlarge", "c6a.large", "c6a.xlarge", "c6a.2xlarge", "c6a.4xlarge", "c6a.8xlarge", "c6a.12xlarge", "c6a.16xlarge", "c6a.24xlarge", "c6i.large", "c6i.xlarge", "c6i.2xlarge", "c6i.4xlarge", "c6i.8xlarge", "c6i.12xlarge", "c6i.16xlarge", "c6i.24xlarge", "r5d.large", "r5d.xlarge", "r5d.2xlarge", "r5d.4xlarge", "r5d.8xlarge", "r5d.12xlarge", "r5d.16xlarge", "r5d.24xlarge"
|
6711
|
+
# resp.compute.game_lift_service_sdk_endpoint #=> String
|
6712
|
+
#
|
6713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterCompute AWS API Documentation
|
6714
|
+
#
|
6715
|
+
# @overload register_compute(params = {})
|
6716
|
+
# @param [Hash] params ({})
|
6717
|
+
def register_compute(params = {}, options = {})
|
6718
|
+
req = build_request(:register_compute, params)
|
6719
|
+
req.send_request(options)
|
6720
|
+
end
|
6721
|
+
|
6684
6722
|
# **This operation is used with the GameLift FleetIQ solution and game
|
6685
6723
|
# server groups.**
|
6686
6724
|
#
|
@@ -6694,8 +6732,6 @@ module Aws::GameLift
|
|
6694
6732
|
# To register a game server, identify the game server group and instance
|
6695
6733
|
# where the game server is running, and provide a unique identifier for
|
6696
6734
|
# the game server. You can also include connection and game server data.
|
6697
|
-
# When a game client or service requests a game server by calling
|
6698
|
-
# ClaimGameServer, this information is returned in the response.
|
6699
6735
|
#
|
6700
6736
|
# Once a game server is successfully registered, it is put in status
|
6701
6737
|
# `AVAILABLE`. A request to register a game server may fail if the
|
@@ -6706,20 +6742,13 @@ module Aws::GameLift
|
|
6706
6742
|
#
|
6707
6743
|
# [GameLift FleetIQ Guide][1]
|
6708
6744
|
#
|
6709
|
-
# **Related actions**
|
6710
|
-
#
|
6711
|
-
# RegisterGameServer \| ListGameServers \| ClaimGameServer \|
|
6712
|
-
# DescribeGameServer \| UpdateGameServer \| DeregisterGameServer \| [All
|
6713
|
-
# APIs by task][2]
|
6714
|
-
#
|
6715
6745
|
#
|
6716
6746
|
#
|
6717
6747
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6718
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
6719
6748
|
#
|
6720
6749
|
# @option params [required, String] :game_server_group_name
|
6721
6750
|
# A unique identifier for the game server group where the game server is
|
6722
|
-
# running.
|
6751
|
+
# running.
|
6723
6752
|
#
|
6724
6753
|
# @option params [required, String] :game_server_id
|
6725
6754
|
# A custom string that uniquely identifies the game server to register.
|
@@ -6739,8 +6768,7 @@ module Aws::GameLift
|
|
6739
6768
|
# @option params [String] :game_server_data
|
6740
6769
|
# A set of custom game server properties, formatted as a single string
|
6741
6770
|
# value. This data is passed to a game client or service when it
|
6742
|
-
# requests information on game servers
|
6743
|
-
# ClaimGameServer.
|
6771
|
+
# requests information on game servers.
|
6744
6772
|
#
|
6745
6773
|
# @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6746
6774
|
#
|
@@ -6781,7 +6809,7 @@ module Aws::GameLift
|
|
6781
6809
|
|
6782
6810
|
# Retrieves a fresh set of credentials for use when uploading a new set
|
6783
6811
|
# of game build files to Amazon GameLift's Amazon S3. This is done as
|
6784
|
-
# part of the build creation process; see
|
6812
|
+
# part of the build creation process; see [GameSession][1].
|
6785
6813
|
#
|
6786
6814
|
# To request new credentials, specify the build ID as returned with an
|
6787
6815
|
# initial `CreateBuild` request. If successful, a new set of credentials
|
@@ -6790,17 +6818,15 @@ module Aws::GameLift
|
|
6790
6818
|
#
|
6791
6819
|
# **Learn more**
|
6792
6820
|
#
|
6793
|
-
# [ Create a Build with Files in S3][
|
6821
|
+
# [ Create a Build with Files in S3][2]
|
6794
6822
|
#
|
6795
|
-
#
|
6796
|
-
#
|
6797
|
-
# CreateBuild \| ListBuilds \| DescribeBuild \| UpdateBuild \|
|
6798
|
-
# DeleteBuild \| [All APIs by task][2]
|
6823
|
+
# [All APIs by task][3]
|
6799
6824
|
#
|
6800
6825
|
#
|
6801
6826
|
#
|
6802
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
6803
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
6827
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html
|
6828
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
6829
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
6804
6830
|
#
|
6805
6831
|
# @option params [required, String] :build_id
|
6806
6832
|
# A unique identifier for the build to get credentials for. You can use
|
@@ -6840,8 +6866,7 @@ module Aws::GameLift
|
|
6840
6866
|
#
|
6841
6867
|
# **Related actions**
|
6842
6868
|
#
|
6843
|
-
#
|
6844
|
-
# DeleteAlias \| ResolveAlias \| [All APIs by task][1]
|
6869
|
+
# [All APIs by task][1]
|
6845
6870
|
#
|
6846
6871
|
#
|
6847
6872
|
#
|
@@ -6880,15 +6905,16 @@ module Aws::GameLift
|
|
6880
6905
|
# server groups.**
|
6881
6906
|
#
|
6882
6907
|
# Reinstates activity on a game server group after it has been
|
6883
|
-
# suspended. A game server group might be suspended by
|
6884
|
-
#
|
6885
|
-
#
|
6886
|
-
#
|
6887
|
-
#
|
6888
|
-
#
|
6908
|
+
# suspended. A game server group might be suspended by the
|
6909
|
+
# [SuspendGameServerGroup](gamelift/latest/apireference/API_SuspendGameServerGroup.html)
|
6910
|
+
# operation, or it might be suspended involuntarily due to a
|
6911
|
+
# configuration problem. In the second case, you can manually resume
|
6912
|
+
# activity on the group once the configuration problem has been
|
6913
|
+
# resolved. Refer to the game server group status and status reason for
|
6914
|
+
# more information on why group activity is suspended.
|
6889
6915
|
#
|
6890
6916
|
# To resume activity, specify a game server group ARN and the type of
|
6891
|
-
# activity to be resumed. If successful, a GameServerGroup object is
|
6917
|
+
# activity to be resumed. If successful, a `GameServerGroup` object is
|
6892
6918
|
# returned showing that the resumed activity is no longer listed in
|
6893
6919
|
# `SuspendedActions`.
|
6894
6920
|
#
|
@@ -6896,22 +6922,13 @@ module Aws::GameLift
|
|
6896
6922
|
#
|
6897
6923
|
# [GameLift FleetIQ Guide][1]
|
6898
6924
|
#
|
6899
|
-
# **Related actions**
|
6900
|
-
#
|
6901
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
6902
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
6903
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
6904
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
6905
|
-
# task][2]
|
6906
|
-
#
|
6907
6925
|
#
|
6908
6926
|
#
|
6909
6927
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6910
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
6911
6928
|
#
|
6912
6929
|
# @option params [required, String] :game_server_group_name
|
6913
|
-
# A unique identifier for the game server group. Use either the
|
6914
|
-
#
|
6930
|
+
# A unique identifier for the game server group. Use either the name or
|
6931
|
+
# ARN value.
|
6915
6932
|
#
|
6916
6933
|
# @option params [required, Array<String>] :resume_actions
|
6917
6934
|
# The activity to resume for this game server group.
|
@@ -6988,17 +7005,15 @@ module Aws::GameLift
|
|
6988
7005
|
# If successful, a `GameSession` object is returned for each game
|
6989
7006
|
# session that matches the request. Search finds game sessions that are
|
6990
7007
|
# in `ACTIVE` status only. To retrieve information on game sessions in
|
6991
|
-
# other statuses, use DescribeGameSessions.
|
7008
|
+
# other statuses, use [DescribeGameSessions][1] .
|
6992
7009
|
#
|
6993
7010
|
# You can search or sort by the following game session attributes:
|
6994
7011
|
#
|
6995
7012
|
# * **gameSessionId** -- A unique identifier for the game session. You
|
6996
7013
|
# can use either a `GameSessionId` or `GameSessionArn` value.
|
6997
7014
|
#
|
6998
|
-
# * **gameSessionName** -- Name assigned to a game session.
|
6999
|
-
#
|
7000
|
-
# updating with UpdateGameSession. Game session names do not need to
|
7001
|
-
# be unique to a game session.
|
7015
|
+
# * **gameSessionName** -- Name assigned to a game session. Game session
|
7016
|
+
# names do not need to be unique to a game session.
|
7002
7017
|
#
|
7003
7018
|
# * **gameSessionProperties** -- Custom data defined in a game
|
7004
7019
|
# session's `GameProperty` parameter. `GameProperty` values are
|
@@ -7010,8 +7025,7 @@ module Aws::GameLift
|
|
7010
7025
|
# are searched as strings.
|
7011
7026
|
#
|
7012
7027
|
# * **maximumSessions** -- Maximum number of player sessions allowed for
|
7013
|
-
# a game session.
|
7014
|
-
# with CreateGameSession or updating with UpdateGameSession.
|
7028
|
+
# a game session.
|
7015
7029
|
#
|
7016
7030
|
# * **creationTimeMillis** -- Value indicating when a game session was
|
7017
7031
|
# created. It is expressed in Unix time as milliseconds.
|
@@ -7034,17 +7048,12 @@ module Aws::GameLift
|
|
7034
7048
|
#
|
7035
7049
|
# </note>
|
7036
7050
|
#
|
7037
|
-
#
|
7038
|
-
#
|
7039
|
-
# CreateGameSession \| DescribeGameSessions \|
|
7040
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
7041
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
7042
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
7043
|
-
# by task][1]
|
7051
|
+
# [All APIs by task][2]
|
7044
7052
|
#
|
7045
7053
|
#
|
7046
7054
|
#
|
7047
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
7055
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html
|
7056
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7048
7057
|
#
|
7049
7058
|
# @option params [String] :fleet_id
|
7050
7059
|
# A unique identifier for the fleet to search for active game sessions.
|
@@ -7192,7 +7201,7 @@ module Aws::GameLift
|
|
7192
7201
|
end
|
7193
7202
|
|
7194
7203
|
# Resumes certain types of activity on fleet instances that were
|
7195
|
-
# suspended with StopFleetActions. For multi-location fleets, fleet
|
7204
|
+
# suspended with [StopFleetActions][1]. For multi-location fleets, fleet
|
7196
7205
|
# actions are managed separately for each location. Currently, this
|
7197
7206
|
# operation is used to restart a fleet's auto-scaling activity.
|
7198
7207
|
#
|
@@ -7207,25 +7216,16 @@ module Aws::GameLift
|
|
7207
7216
|
#
|
7208
7217
|
# If successful, GameLift once again initiates scaling events as
|
7209
7218
|
# triggered by the fleet's scaling policies. If actions on the fleet
|
7210
|
-
# location were never stopped, this operation will have no effect.
|
7211
|
-
# can view a fleet's stopped actions using DescribeFleetAttributes or
|
7212
|
-
# DescribeFleetLocationAttributes.
|
7219
|
+
# location were never stopped, this operation will have no effect.
|
7213
7220
|
#
|
7214
7221
|
# **Learn more**
|
7215
7222
|
#
|
7216
|
-
# [Setting up GameLift fleets][
|
7217
|
-
#
|
7218
|
-
# **Related actions**
|
7219
|
-
#
|
7220
|
-
# CreateFleet \| UpdateFleetCapacity \| PutScalingPolicy \|
|
7221
|
-
# DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
7222
|
-
# DescribeFleetLocationAttributes \| UpdateFleetAttributes \|
|
7223
|
-
# StopFleetActions \| DeleteFleet \| [All APIs by task][2]
|
7223
|
+
# [Setting up GameLift fleets][2]
|
7224
7224
|
#
|
7225
7225
|
#
|
7226
7226
|
#
|
7227
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
7228
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
7227
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html
|
7228
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
7229
7229
|
#
|
7230
7230
|
# @option params [required, String] :fleet_id
|
7231
7231
|
# A unique identifier for the fleet to restart actions on. You can use
|
@@ -7265,11 +7265,10 @@ module Aws::GameLift
|
|
7265
7265
|
req.send_request(options)
|
7266
7266
|
end
|
7267
7267
|
|
7268
|
-
# Places a request for a new game session in a queue
|
7269
|
-
#
|
7270
|
-
#
|
7271
|
-
#
|
7272
|
-
# request times out.
|
7268
|
+
# Places a request for a new game session in a queue. When processing a
|
7269
|
+
# placement request, Amazon GameLift searches for available resources on
|
7270
|
+
# the queue's destinations, scanning each until it finds resources or
|
7271
|
+
# the placement request times out.
|
7273
7272
|
#
|
7274
7273
|
# A game session placement request can also request player sessions.
|
7275
7274
|
# When a new game session is successfully created, Amazon GameLift
|
@@ -7306,28 +7305,20 @@ module Aws::GameLift
|
|
7306
7305
|
# If successful, a new game session placement is created.
|
7307
7306
|
#
|
7308
7307
|
# To track the status of a placement request, call
|
7309
|
-
# DescribeGameSessionPlacement and check the request's status. If
|
7310
|
-
# status is `FULFILLED`, a new game session has been created and a
|
7311
|
-
# session ARN and Region are referenced. If the placement request
|
7312
|
-
# out, you can resubmit the request or retry it with a different
|
7308
|
+
# [DescribeGameSessionPlacement][1] and check the request's status. If
|
7309
|
+
# the status is `FULFILLED`, a new game session has been created and a
|
7310
|
+
# game session ARN and Region are referenced. If the placement request
|
7311
|
+
# times out, you can resubmit the request or retry it with a different
|
7312
|
+
# queue.
|
7313
7313
|
#
|
7314
|
-
# **Related actions**
|
7315
7314
|
#
|
7316
|
-
# CreateGameSession \| DescribeGameSessions \|
|
7317
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
7318
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
7319
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
7320
|
-
# by task][1]
|
7321
7315
|
#
|
7322
|
-
#
|
7323
|
-
#
|
7324
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7316
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html
|
7325
7317
|
#
|
7326
7318
|
# @option params [required, String] :placement_id
|
7327
7319
|
# A unique identifier to assign to the new game session placement. This
|
7328
7320
|
# value is developer-defined. The value must be unique across all
|
7329
|
-
# Regions and cannot be reused
|
7330
|
-
# timed-out placement request.
|
7321
|
+
# Regions and cannot be reused.
|
7331
7322
|
#
|
7332
7323
|
# @option params [required, String] :game_session_queue_name
|
7333
7324
|
# Name of the queue to use to place the new game session. You can use
|
@@ -7335,9 +7326,8 @@ module Aws::GameLift
|
|
7335
7326
|
#
|
7336
7327
|
# @option params [Array<Types::GameProperty>] :game_properties
|
7337
7328
|
# A set of custom properties for a game session, formatted as key:value
|
7338
|
-
# pairs. These properties are passed to a game server process
|
7339
|
-
#
|
7340
|
-
# [Start a Game Session][1]).
|
7329
|
+
# pairs. These properties are passed to a game server process with a
|
7330
|
+
# request to start a new game session (see [Start a Game Session][1]).
|
7341
7331
|
#
|
7342
7332
|
#
|
7343
7333
|
#
|
@@ -7353,18 +7343,19 @@ module Aws::GameLift
|
|
7353
7343
|
#
|
7354
7344
|
# @option params [Array<Types::PlayerLatency>] :player_latencies
|
7355
7345
|
# A set of values, expressed in milliseconds, that indicates the amount
|
7356
|
-
# of latency that a player experiences when connected to
|
7357
|
-
# This information is used to try to place the new
|
7358
|
-
# can offer the best possible gameplay experience
|
7346
|
+
# of latency that a player experiences when connected to Amazon Web
|
7347
|
+
# Services Regions. This information is used to try to place the new
|
7348
|
+
# game session where it can offer the best possible gameplay experience
|
7349
|
+
# for the players.
|
7359
7350
|
#
|
7360
7351
|
# @option params [Array<Types::DesiredPlayerSession>] :desired_player_sessions
|
7361
7352
|
# Set of information on each player to create a player session for.
|
7362
7353
|
#
|
7363
7354
|
# @option params [String] :game_session_data
|
7364
7355
|
# A set of custom game session properties, formatted as a single string
|
7365
|
-
# value. This data is passed to a game server process in the
|
7366
|
-
# object with a request to start a new game session (see
|
7367
|
-
# Session][1]).
|
7356
|
+
# value. This data is passed to a game server process in the
|
7357
|
+
# `GameSession` object with a request to start a new game session (see
|
7358
|
+
# [Start a Game Session][1]).
|
7368
7359
|
#
|
7369
7360
|
#
|
7370
7361
|
#
|
@@ -7450,7 +7441,7 @@ module Aws::GameLift
|
|
7450
7441
|
#
|
7451
7442
|
# When using FlexMatch with GameLift managed hosting, you can request a
|
7452
7443
|
# backfill match from a client service by calling this operation with a
|
7453
|
-
#
|
7444
|
+
# `GameSessions` ID. You also have the option of making backfill
|
7454
7445
|
# requests directly from your game server. In response to a request,
|
7455
7446
|
# FlexMatch creates player sessions for the new players, updates the
|
7456
7447
|
# `GameSession` resource, and sends updated matchmaking data to the game
|
@@ -7483,17 +7474,11 @@ module Aws::GameLift
|
|
7483
7474
|
#
|
7484
7475
|
# [ How GameLift FlexMatch works][3]
|
7485
7476
|
#
|
7486
|
-
# **Related actions**
|
7487
|
-
#
|
7488
|
-
# StartMatchmaking \| DescribeMatchmaking \| StopMatchmaking \|
|
7489
|
-
# AcceptMatch \| StartMatchBackfill \| [All APIs by task][4]
|
7490
|
-
#
|
7491
7477
|
#
|
7492
7478
|
#
|
7493
7479
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html
|
7494
7480
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html
|
7495
7481
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html
|
7496
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7497
7482
|
#
|
7498
7483
|
# @option params [String] :ticket_id
|
7499
7484
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
@@ -7504,7 +7489,7 @@ module Aws::GameLift
|
|
7504
7489
|
# @option params [required, String] :configuration_name
|
7505
7490
|
# Name of the matchmaker to use for this request. You can use either the
|
7506
7491
|
# configuration name or ARN value. The ARN of the matchmaker that was
|
7507
|
-
# used with the original game session is listed in the GameSession
|
7492
|
+
# used with the original game session is listed in the `GameSession`
|
7508
7493
|
# object, `MatchmakerData` property.
|
7509
7494
|
#
|
7510
7495
|
# @option params [String] :game_session_arn
|
@@ -7517,8 +7502,10 @@ module Aws::GameLift
|
|
7517
7502
|
# game session. This information is used by the matchmaker to find new
|
7518
7503
|
# players and add them to the existing game.
|
7519
7504
|
#
|
7505
|
+
# You can include up to 199 `Players` in a `StartMatchBackfill` request.
|
7506
|
+
#
|
7520
7507
|
# * PlayerID, PlayerAttributes, Team -- This information is maintained
|
7521
|
-
# in the GameSession object, `MatchmakerData` property, for all
|
7508
|
+
# in the `GameSession` object, `MatchmakerData` property, for all
|
7522
7509
|
# players who are currently assigned to the game session. The
|
7523
7510
|
# matchmaker data is in JSON syntax, formatted as a string. For more
|
7524
7511
|
# details, see [ Match Data][1].
|
@@ -7623,17 +7610,11 @@ module Aws::GameLift
|
|
7623
7610
|
#
|
7624
7611
|
# [ How GameLift FlexMatch works][3]
|
7625
7612
|
#
|
7626
|
-
# **Related actions**
|
7627
|
-
#
|
7628
|
-
# StartMatchmaking \| DescribeMatchmaking \| StopMatchmaking \|
|
7629
|
-
# AcceptMatch \| StartMatchBackfill \| [All APIs by task][4]
|
7630
|
-
#
|
7631
7613
|
#
|
7632
7614
|
#
|
7633
7615
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
7634
7616
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
7635
7617
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html
|
7636
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7637
7618
|
#
|
7638
7619
|
# @option params [String] :ticket_id
|
7639
7620
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
@@ -7653,6 +7634,8 @@ module Aws::GameLift
|
|
7653
7634
|
# `Player` objects contain the name of the team the player is assigned
|
7654
7635
|
# to.
|
7655
7636
|
#
|
7637
|
+
# You can include up to 10 `Players` in a `StartMatchmaking` request.
|
7638
|
+
#
|
7656
7639
|
# @return [Types::StartMatchmakingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7657
7640
|
#
|
7658
7641
|
# * {Types::StartMatchmakingOutput#matchmaking_ticket #matchmaking_ticket} => Types::MatchmakingTicket
|
@@ -7732,26 +7715,16 @@ module Aws::GameLift
|
|
7732
7715
|
# actions to suspend.
|
7733
7716
|
#
|
7734
7717
|
# If successful, GameLift no longer initiates scaling events except in
|
7735
|
-
# response to manual changes using UpdateFleetCapacity.
|
7736
|
-
# fleet's stopped actions using DescribeFleetAttributes or
|
7737
|
-
# DescribeFleetLocationAttributes. Suspended activity can be restarted
|
7738
|
-
# using StartFleetActions.
|
7718
|
+
# response to manual changes using [UpdateFleetCapacity][1].
|
7739
7719
|
#
|
7740
7720
|
# **Learn more**
|
7741
7721
|
#
|
7742
|
-
# [Setting up GameLift Fleets][
|
7722
|
+
# [Setting up GameLift Fleets][2]
|
7743
7723
|
#
|
7744
|
-
# **Related actions**
|
7745
7724
|
#
|
7746
|
-
# CreateFleet \| UpdateFleetCapacity \| PutScalingPolicy \|
|
7747
|
-
# DescribeEC2InstanceLimits \| DescribeFleetAttributes \|
|
7748
|
-
# DescribeFleetLocationAttributes \| UpdateFleetAttributes \|
|
7749
|
-
# StopFleetActions \| DeleteFleet \| [All APIs by task][2]
|
7750
7725
|
#
|
7751
|
-
#
|
7752
|
-
#
|
7753
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
7754
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7726
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html
|
7727
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
7755
7728
|
#
|
7756
7729
|
# @option params [required, String] :fleet_id
|
7757
7730
|
# A unique identifier for the fleet to stop actions on. You can use
|
@@ -7795,20 +7768,8 @@ module Aws::GameLift
|
|
7795
7768
|
# a placement, provide the placement ID values. If successful, the
|
7796
7769
|
# placement is moved to `CANCELLED` status.
|
7797
7770
|
#
|
7798
|
-
# **Related actions**
|
7799
|
-
#
|
7800
|
-
# CreateGameSession \| DescribeGameSessions \|
|
7801
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
7802
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
7803
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
7804
|
-
# by task][1]
|
7805
|
-
#
|
7806
|
-
#
|
7807
|
-
#
|
7808
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7809
|
-
#
|
7810
7771
|
# @option params [required, String] :placement_id
|
7811
|
-
# A unique identifier for a game session placement to
|
7772
|
+
# A unique identifier for a game session placement to stop.
|
7812
7773
|
#
|
7813
7774
|
# @return [Types::StopGameSessionPlacementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7814
7775
|
#
|
@@ -7877,15 +7838,9 @@ module Aws::GameLift
|
|
7877
7838
|
#
|
7878
7839
|
# [ Add FlexMatch to a game client][1]
|
7879
7840
|
#
|
7880
|
-
# **Related actions**
|
7881
|
-
#
|
7882
|
-
# StartMatchmaking \| DescribeMatchmaking \| StopMatchmaking \|
|
7883
|
-
# AcceptMatch \| StartMatchBackfill \| [All APIs by task][2]
|
7884
|
-
#
|
7885
7841
|
#
|
7886
7842
|
#
|
7887
7843
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
7888
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
7889
7844
|
#
|
7890
7845
|
# @option params [required, String] :ticket_id
|
7891
7846
|
# A unique identifier for a matchmaking ticket.
|
@@ -7912,7 +7867,9 @@ module Aws::GameLift
|
|
7912
7867
|
#
|
7913
7868
|
# Temporarily stops activity on a game server group without terminating
|
7914
7869
|
# instances or the game server group. You can restart activity by
|
7915
|
-
# calling
|
7870
|
+
# calling
|
7871
|
+
# [ResumeGameServerGroup](gamelift/latest/apireference/API_ResumeGameServerGroup.html).
|
7872
|
+
# You can suspend the following activity:
|
7916
7873
|
#
|
7917
7874
|
# * **Instance type replacement** - This activity evaluates the current
|
7918
7875
|
# game hosting viability of all Spot instance types that are defined
|
@@ -7927,29 +7884,20 @@ module Aws::GameLift
|
|
7927
7884
|
# ^
|
7928
7885
|
#
|
7929
7886
|
# To suspend activity, specify a game server group ARN and the type of
|
7930
|
-
# activity to be suspended. If successful, a GameServerGroup object is
|
7887
|
+
# activity to be suspended. If successful, a `GameServerGroup` object is
|
7931
7888
|
# returned showing that the activity is listed in `SuspendedActions`.
|
7932
7889
|
#
|
7933
7890
|
# **Learn more**
|
7934
7891
|
#
|
7935
7892
|
# [GameLift FleetIQ Guide][1]
|
7936
7893
|
#
|
7937
|
-
# **Related actions**
|
7938
|
-
#
|
7939
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
7940
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
7941
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
7942
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
7943
|
-
# task][2]
|
7944
|
-
#
|
7945
7894
|
#
|
7946
7895
|
#
|
7947
7896
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
7948
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
7949
7897
|
#
|
7950
7898
|
# @option params [required, String] :game_server_group_name
|
7951
|
-
# A unique identifier for the game server group. Use either the
|
7952
|
-
#
|
7899
|
+
# A unique identifier for the game server group. Use either the name or
|
7900
|
+
# ARN value.
|
7953
7901
|
#
|
7954
7902
|
# @option params [required, Array<String>] :suspend_actions
|
7955
7903
|
# The activity to suspend for this game server group.
|
@@ -8027,8 +7975,7 @@ module Aws::GameLift
|
|
8027
7975
|
#
|
8028
7976
|
# **Related actions**
|
8029
7977
|
#
|
8030
|
-
#
|
8031
|
-
# task][3]
|
7978
|
+
# [All APIs by task][3]
|
8032
7979
|
#
|
8033
7980
|
#
|
8034
7981
|
#
|
@@ -8113,8 +8060,7 @@ module Aws::GameLift
|
|
8113
8060
|
#
|
8114
8061
|
# **Related actions**
|
8115
8062
|
#
|
8116
|
-
#
|
8117
|
-
# task][3]
|
8063
|
+
# [All APIs by task][3]
|
8118
8064
|
#
|
8119
8065
|
#
|
8120
8066
|
#
|
@@ -8164,8 +8110,7 @@ module Aws::GameLift
|
|
8164
8110
|
#
|
8165
8111
|
# **Related actions**
|
8166
8112
|
#
|
8167
|
-
#
|
8168
|
-
# DeleteAlias \| ResolveAlias \| [All APIs by task][1]
|
8113
|
+
# [All APIs by task][1]
|
8169
8114
|
#
|
8170
8115
|
#
|
8171
8116
|
#
|
@@ -8233,10 +8178,7 @@ module Aws::GameLift
|
|
8233
8178
|
#
|
8234
8179
|
# [ Upload a Custom Server Build][1]
|
8235
8180
|
#
|
8236
|
-
#
|
8237
|
-
#
|
8238
|
-
# CreateBuild \| ListBuilds \| DescribeBuild \| UpdateBuild \|
|
8239
|
-
# DeleteBuild \| [All APIs by task][2]
|
8181
|
+
# [All APIs by task][2]
|
8240
8182
|
#
|
8241
8183
|
#
|
8242
8184
|
#
|
@@ -8248,12 +8190,12 @@ module Aws::GameLift
|
|
8248
8190
|
# build ID or ARN value.
|
8249
8191
|
#
|
8250
8192
|
# @option params [String] :name
|
8251
|
-
# A descriptive label
|
8252
|
-
#
|
8193
|
+
# A descriptive label associated with a build. Build names do not need
|
8194
|
+
# to be unique.
|
8253
8195
|
#
|
8254
8196
|
# @option params [String] :version
|
8255
|
-
# Version information
|
8256
|
-
#
|
8197
|
+
# Version information associated with a build or script. Version strings
|
8198
|
+
# do not need to be unique.
|
8257
8199
|
#
|
8258
8200
|
# @return [Types::UpdateBuildOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8259
8201
|
#
|
@@ -8277,6 +8219,7 @@ module Aws::GameLift
|
|
8277
8219
|
# resp.build.size_on_disk #=> Integer
|
8278
8220
|
# resp.build.operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
8279
8221
|
# resp.build.creation_time #=> Time
|
8222
|
+
# resp.build.server_sdk_version #=> String
|
8280
8223
|
#
|
8281
8224
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateBuild AWS API Documentation
|
8282
8225
|
#
|
@@ -8299,18 +8242,9 @@ module Aws::GameLift
|
|
8299
8242
|
#
|
8300
8243
|
# [Setting up GameLift fleets][1]
|
8301
8244
|
#
|
8302
|
-
# **Related actions**
|
8303
|
-
#
|
8304
|
-
# CreateFleetLocations \| UpdateFleetAttributes \| UpdateFleetCapacity
|
8305
|
-
# \| UpdateFleetPortSettings \| UpdateRuntimeConfiguration \|
|
8306
|
-
# StopFleetActions \| StartFleetActions \| PutScalingPolicy \|
|
8307
|
-
# DeleteFleet \| DeleteFleetLocations \| DeleteScalingPolicy \| [All
|
8308
|
-
# APIs by task][2]
|
8309
|
-
#
|
8310
8245
|
#
|
8311
8246
|
#
|
8312
8247
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
8313
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
8314
8248
|
#
|
8315
8249
|
# @option params [required, String] :fleet_id
|
8316
8250
|
# A unique identifier for the fleet to update attribute metadata for.
|
@@ -8327,7 +8261,7 @@ module Aws::GameLift
|
|
8327
8261
|
# The game session protection policy to apply to all new instances
|
8328
8262
|
# created in this fleet. Instances that already exist are not affected.
|
8329
8263
|
# You can set protection for individual instances using
|
8330
|
-
# UpdateGameSession.
|
8264
|
+
# [UpdateGameSession][1] .
|
8331
8265
|
#
|
8332
8266
|
# * **NoProtection** -- The game session can be terminated during a
|
8333
8267
|
# scale-down event.
|
@@ -8335,6 +8269,10 @@ module Aws::GameLift
|
|
8335
8269
|
# * **FullProtection** -- If the game session is in an `ACTIVE` status,
|
8336
8270
|
# it cannot be terminated during a scale-down event.
|
8337
8271
|
#
|
8272
|
+
#
|
8273
|
+
#
|
8274
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html
|
8275
|
+
#
|
8338
8276
|
# @option params [Types::ResourceCreationLimitPolicy] :resource_creation_limit_policy
|
8339
8277
|
# Policy settings that limit the number of game sessions an individual
|
8340
8278
|
# player can create over a span of time.
|
@@ -8346,9 +8284,13 @@ module Aws::GameLift
|
|
8346
8284
|
# providing a new name. A fleet can only be in one metric group at a
|
8347
8285
|
# time.
|
8348
8286
|
#
|
8287
|
+
# @option params [Types::AnywhereConfiguration] :anywhere_configuration
|
8288
|
+
# GameLift Anywhere configuration options.
|
8289
|
+
#
|
8349
8290
|
# @return [Types::UpdateFleetAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8350
8291
|
#
|
8351
8292
|
# * {Types::UpdateFleetAttributesOutput#fleet_id #fleet_id} => String
|
8293
|
+
# * {Types::UpdateFleetAttributesOutput#fleet_arn #fleet_arn} => String
|
8352
8294
|
#
|
8353
8295
|
# @example Request syntax with placeholder values
|
8354
8296
|
#
|
@@ -8362,11 +8304,15 @@ module Aws::GameLift
|
|
8362
8304
|
# policy_period_in_minutes: 1,
|
8363
8305
|
# },
|
8364
8306
|
# metric_groups: ["MetricGroup"],
|
8307
|
+
# anywhere_configuration: {
|
8308
|
+
# cost: "NonNegativeLimitedLengthDouble", # required
|
8309
|
+
# },
|
8365
8310
|
# })
|
8366
8311
|
#
|
8367
8312
|
# @example Response structure
|
8368
8313
|
#
|
8369
8314
|
# resp.fleet_id #=> String
|
8315
|
+
# resp.fleet_arn #=> String
|
8370
8316
|
#
|
8371
8317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetAttributes AWS API Documentation
|
8372
8318
|
#
|
@@ -8391,10 +8337,10 @@ module Aws::GameLift
|
|
8391
8337
|
#
|
8392
8338
|
# * Desired capacity: Manually set the number of Amazon EC2 instances to
|
8393
8339
|
# be maintained in a fleet location. Before changing a fleet's
|
8394
|
-
# desired capacity, you may want to call
|
8395
|
-
# get the maximum capacity of the
|
8396
|
-
#
|
8397
|
-
# based on player demand.
|
8340
|
+
# desired capacity, you may want to call
|
8341
|
+
# [DescribeEC2InstanceLimits][1] to get the maximum capacity of the
|
8342
|
+
# fleet's Amazon EC2 instance type. Alternatively, consider using
|
8343
|
+
# automatic scaling to adjust capacity based on player demand.
|
8398
8344
|
#
|
8399
8345
|
# This operation can be used in the following ways:
|
8400
8346
|
#
|
@@ -8411,27 +8357,21 @@ module Aws::GameLift
|
|
8411
8357
|
# instances or terminate existing instances in the requested fleet
|
8412
8358
|
# location. This continues until the location's active instance count
|
8413
8359
|
# matches the new desired instance count. You can track a fleet's
|
8414
|
-
# current capacity by calling DescribeFleetCapacity or
|
8415
|
-
# DescribeFleetLocationCapacity. If the requested desired instance
|
8416
|
-
# is higher than the instance type's limit, the `LimitExceeded`
|
8360
|
+
# current capacity by calling [DescribeFleetCapacity][2] or
|
8361
|
+
# [DescribeFleetLocationCapacity][3]. If the requested desired instance
|
8362
|
+
# count is higher than the instance type's limit, the `LimitExceeded`
|
8417
8363
|
# exception occurs.
|
8418
8364
|
#
|
8419
8365
|
# **Learn more**
|
8420
8366
|
#
|
8421
|
-
# [Scaling fleet capacity][
|
8422
|
-
#
|
8423
|
-
# **Related actions**
|
8424
|
-
#
|
8425
|
-
# CreateFleetLocations \| UpdateFleetAttributes \| UpdateFleetCapacity
|
8426
|
-
# \| UpdateFleetPortSettings \| UpdateRuntimeConfiguration \|
|
8427
|
-
# StopFleetActions \| StartFleetActions \| PutScalingPolicy \|
|
8428
|
-
# DeleteFleet \| DeleteFleetLocations \| DeleteScalingPolicy \| [All
|
8429
|
-
# APIs by task][2]
|
8367
|
+
# [Scaling fleet capacity][4]
|
8430
8368
|
#
|
8431
8369
|
#
|
8432
8370
|
#
|
8433
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
8434
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
8371
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html
|
8372
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html
|
8373
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html
|
8374
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html
|
8435
8375
|
#
|
8436
8376
|
# @option params [required, String] :fleet_id
|
8437
8377
|
# A unique identifier for the fleet to update capacity settings for. You
|
@@ -8504,18 +8444,9 @@ module Aws::GameLift
|
|
8504
8444
|
#
|
8505
8445
|
# [Setting up GameLift fleets][1]
|
8506
8446
|
#
|
8507
|
-
# **Related actions**
|
8508
|
-
#
|
8509
|
-
# CreateFleetLocations \| UpdateFleetAttributes \| UpdateFleetCapacity
|
8510
|
-
# \| UpdateFleetPortSettings \| UpdateRuntimeConfiguration \|
|
8511
|
-
# StopFleetActions \| StartFleetActions \| PutScalingPolicy \|
|
8512
|
-
# DeleteFleet \| DeleteFleetLocations \| DeleteScalingPolicy \| [All
|
8513
|
-
# APIs by task][2]
|
8514
|
-
#
|
8515
8447
|
#
|
8516
8448
|
#
|
8517
8449
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
8518
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
8519
8450
|
#
|
8520
8451
|
# @option params [required, String] :fleet_id
|
8521
8452
|
# A unique identifier for the fleet to update port settings for. You can
|
@@ -8530,6 +8461,7 @@ module Aws::GameLift
|
|
8530
8461
|
# @return [Types::UpdateFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8531
8462
|
#
|
8532
8463
|
# * {Types::UpdateFleetPortSettingsOutput#fleet_id #fleet_id} => String
|
8464
|
+
# * {Types::UpdateFleetPortSettingsOutput#fleet_arn #fleet_arn} => String
|
8533
8465
|
#
|
8534
8466
|
# @example Request syntax with placeholder values
|
8535
8467
|
#
|
@@ -8556,6 +8488,7 @@ module Aws::GameLift
|
|
8556
8488
|
# @example Response structure
|
8557
8489
|
#
|
8558
8490
|
# resp.fleet_id #=> String
|
8491
|
+
# resp.fleet_arn #=> String
|
8559
8492
|
#
|
8560
8493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateFleetPortSettings AWS API Documentation
|
8561
8494
|
#
|
@@ -8600,20 +8533,13 @@ module Aws::GameLift
|
|
8600
8533
|
#
|
8601
8534
|
# [GameLift FleetIQ Guide][1]
|
8602
8535
|
#
|
8603
|
-
# **Related actions**
|
8604
|
-
#
|
8605
|
-
# RegisterGameServer \| ListGameServers \| ClaimGameServer \|
|
8606
|
-
# DescribeGameServer \| UpdateGameServer \| DeregisterGameServer \| [All
|
8607
|
-
# APIs by task][2]
|
8608
|
-
#
|
8609
8536
|
#
|
8610
8537
|
#
|
8611
8538
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
8612
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
8613
8539
|
#
|
8614
8540
|
# @option params [required, String] :game_server_group_name
|
8615
8541
|
# A unique identifier for the game server group where the game server is
|
8616
|
-
# running.
|
8542
|
+
# running.
|
8617
8543
|
#
|
8618
8544
|
# @option params [required, String] :game_server_id
|
8619
8545
|
# A custom string that uniquely identifies the game server to update.
|
@@ -8621,8 +8547,7 @@ module Aws::GameLift
|
|
8621
8547
|
# @option params [String] :game_server_data
|
8622
8548
|
# A set of custom game server properties, formatted as a single string
|
8623
8549
|
# value. This data is passed to a game client or service when it
|
8624
|
-
# requests information on game servers
|
8625
|
-
# ClaimGameServer.
|
8550
|
+
# requests information on game servers.
|
8626
8551
|
#
|
8627
8552
|
# @option params [String] :utilization_status
|
8628
8553
|
# Indicates whether the game server is available or is currently hosting
|
@@ -8681,29 +8606,20 @@ module Aws::GameLift
|
|
8681
8606
|
# To update the game server group, specify the game server group ID and
|
8682
8607
|
# provide the updated values. Before applying the updates, the new
|
8683
8608
|
# values are validated to ensure that GameLift FleetIQ can continue to
|
8684
|
-
# perform instance balancing activity. If successful, a
|
8685
|
-
# object is returned.
|
8609
|
+
# perform instance balancing activity. If successful, a
|
8610
|
+
# `GameServerGroup` object is returned.
|
8686
8611
|
#
|
8687
8612
|
# **Learn more**
|
8688
8613
|
#
|
8689
8614
|
# [GameLift FleetIQ Guide][1]
|
8690
8615
|
#
|
8691
|
-
# **Related actions**
|
8692
|
-
#
|
8693
|
-
# CreateGameServerGroup \| ListGameServerGroups \|
|
8694
|
-
# DescribeGameServerGroup \| UpdateGameServerGroup \|
|
8695
|
-
# DeleteGameServerGroup \| ResumeGameServerGroup \|
|
8696
|
-
# SuspendGameServerGroup \| DescribeGameServerInstances \| [All APIs by
|
8697
|
-
# task][2]
|
8698
|
-
#
|
8699
8616
|
#
|
8700
8617
|
#
|
8701
8618
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
8702
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html
|
8703
8619
|
#
|
8704
8620
|
# @option params [required, String] :game_server_group_name
|
8705
|
-
# A unique identifier for the game server group. Use either the
|
8706
|
-
#
|
8621
|
+
# A unique identifier for the game server group. Use either the name or
|
8622
|
+
# ARN value.
|
8707
8623
|
#
|
8708
8624
|
# @option params [String] :role_arn
|
8709
8625
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
@@ -8818,13 +8734,7 @@ module Aws::GameLift
|
|
8818
8734
|
#
|
8819
8735
|
# If successful, the updated `GameSession` object is returned.
|
8820
8736
|
#
|
8821
|
-
#
|
8822
|
-
#
|
8823
|
-
# CreateGameSession \| DescribeGameSessions \|
|
8824
|
-
# DescribeGameSessionDetails \| SearchGameSessions \| UpdateGameSession
|
8825
|
-
# \| GetGameSessionLogUrl \| StartGameSessionPlacement \|
|
8826
|
-
# DescribeGameSessionPlacement \| StopGameSessionPlacement \| [All APIs
|
8827
|
-
# by task][1]
|
8737
|
+
# [All APIs by task][1]
|
8828
8738
|
#
|
8829
8739
|
#
|
8830
8740
|
#
|
@@ -8910,20 +8820,9 @@ module Aws::GameLift
|
|
8910
8820
|
#
|
8911
8821
|
# [ Using Multi-Region Queues][1]
|
8912
8822
|
#
|
8913
|
-
# **Related actions**
|
8914
|
-
#
|
8915
|
-
# [CreateGameSessionQueue][2] \| [DescribeGameSessionQueues][3] \|
|
8916
|
-
# [UpdateGameSessionQueue][4] \| [DeleteGameSessionQueue][5] \| [All
|
8917
|
-
# APIs by task][6]
|
8918
|
-
#
|
8919
8823
|
#
|
8920
8824
|
#
|
8921
8825
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
8922
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
8923
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
8924
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
8925
|
-
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
8926
|
-
# [6]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
8927
8826
|
#
|
8928
8827
|
# @option params [required, String] :name
|
8929
8828
|
# A descriptive label that is associated with game session queue. Queue
|
@@ -9048,25 +8947,16 @@ module Aws::GameLift
|
|
9048
8947
|
#
|
9049
8948
|
# [ Design a FlexMatch matchmaker][1]
|
9050
8949
|
#
|
9051
|
-
# **Related actions**
|
9052
|
-
#
|
9053
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
9054
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
9055
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
9056
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
9057
|
-
# task][2]
|
9058
|
-
#
|
9059
8950
|
#
|
9060
8951
|
#
|
9061
8952
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
|
9062
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
9063
8953
|
#
|
9064
8954
|
# @option params [required, String] :name
|
9065
8955
|
# A unique identifier for the matchmaking configuration to update. You
|
9066
8956
|
# can use either the configuration name or ARN value.
|
9067
8957
|
#
|
9068
8958
|
# @option params [String] :description
|
9069
|
-
# A
|
8959
|
+
# A description for the matchmaking configuration.
|
9070
8960
|
#
|
9071
8961
|
# @option params [Array<String>] :game_session_queue_arns
|
9072
8962
|
# The Amazon Resource Name ([ARN][1]) that is assigned to a GameLift
|
@@ -9126,11 +9016,11 @@ module Aws::GameLift
|
|
9126
9016
|
#
|
9127
9017
|
# @option params [Array<Types::GameProperty>] :game_properties
|
9128
9018
|
# A set of custom properties for a game session, formatted as key:value
|
9129
|
-
# pairs. These properties are passed to a game server process
|
9130
|
-
#
|
9131
|
-
#
|
9132
|
-
#
|
9133
|
-
#
|
9019
|
+
# pairs. These properties are passed to a game server process with a
|
9020
|
+
# request to start a new game session (see [Start a Game Session][1]).
|
9021
|
+
# This information is added to the new `GameSession` object that is
|
9022
|
+
# created for a successful match. This parameter is not used if
|
9023
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
9134
9024
|
#
|
9135
9025
|
#
|
9136
9026
|
#
|
@@ -9138,11 +9028,11 @@ module Aws::GameLift
|
|
9138
9028
|
#
|
9139
9029
|
# @option params [String] :game_session_data
|
9140
9030
|
# A set of custom game session properties, formatted as a single string
|
9141
|
-
# value. This data is passed to a game server process
|
9142
|
-
#
|
9143
|
-
#
|
9144
|
-
#
|
9145
|
-
#
|
9031
|
+
# value. This data is passed to a game server process with a request to
|
9032
|
+
# start a new game session (see [Start a Game Session][1]). This
|
9033
|
+
# information is added to the game session that is created for a
|
9034
|
+
# successful match. This parameter is not used if `FlexMatchMode` is set
|
9035
|
+
# to `STANDALONE`.
|
9146
9036
|
#
|
9147
9037
|
#
|
9148
9038
|
#
|
@@ -9152,7 +9042,7 @@ module Aws::GameLift
|
|
9152
9042
|
# The method that is used to backfill game sessions created with this
|
9153
9043
|
# matchmaking configuration. Specify MANUAL when your game manages
|
9154
9044
|
# backfill requests manually or does not use the match backfill feature.
|
9155
|
-
# Specify AUTOMATIC to have GameLift create a
|
9045
|
+
# Specify AUTOMATIC to have GameLift create a match backfill request
|
9156
9046
|
# whenever a game session has one or more open slots. Learn more about
|
9157
9047
|
# manual and automatic backfill in [Backfill Existing Games with
|
9158
9048
|
# FlexMatch][1]. Automatic backfill is not available when
|
@@ -9258,25 +9148,16 @@ module Aws::GameLift
|
|
9258
9148
|
#
|
9259
9149
|
# [Setting up GameLift fleets][1]
|
9260
9150
|
#
|
9261
|
-
# **Related actions**
|
9262
|
-
#
|
9263
|
-
# CreateFleetLocations \| UpdateFleetAttributes \| UpdateFleetCapacity
|
9264
|
-
# \| UpdateFleetPortSettings \| UpdateRuntimeConfiguration \|
|
9265
|
-
# StopFleetActions \| StartFleetActions \| PutScalingPolicy \|
|
9266
|
-
# DeleteFleet \| DeleteFleetLocations \| DeleteScalingPolicy \| [All
|
9267
|
-
# APIs by task][2]
|
9268
|
-
#
|
9269
9151
|
#
|
9270
9152
|
#
|
9271
9153
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
9272
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
9273
9154
|
#
|
9274
9155
|
# @option params [required, String] :fleet_id
|
9275
9156
|
# A unique identifier for the fleet to update runtime configuration for.
|
9276
9157
|
# You can use either the fleet ID or ARN value.
|
9277
9158
|
#
|
9278
9159
|
# @option params [required, Types::RuntimeConfiguration] :runtime_configuration
|
9279
|
-
# Instructions for
|
9160
|
+
# Instructions for alaunching server processes on each instance in the
|
9280
9161
|
# fleet. Server processes run either a custom game build executable or a
|
9281
9162
|
# Realtime Servers script. The runtime configuration lists the types of
|
9282
9163
|
# server processes to run on an instance, how to launch them, and the
|
@@ -9342,8 +9223,7 @@ module Aws::GameLift
|
|
9342
9223
|
#
|
9343
9224
|
# **Related actions**
|
9344
9225
|
#
|
9345
|
-
#
|
9346
|
-
# DeleteScript \| [All APIs by task][2]
|
9226
|
+
# [All APIs by task][2]
|
9347
9227
|
#
|
9348
9228
|
#
|
9349
9229
|
#
|
@@ -9359,8 +9239,8 @@ module Aws::GameLift
|
|
9359
9239
|
# not need to be unique.
|
9360
9240
|
#
|
9361
9241
|
# @option params [String] :version
|
9362
|
-
# Version information
|
9363
|
-
#
|
9242
|
+
# Version information associated with a build or script. Version strings
|
9243
|
+
# do not need to be unique.
|
9364
9244
|
#
|
9365
9245
|
# @option params [Types::S3Location] :storage_location
|
9366
9246
|
# The location of the Amazon S3 bucket where a zipped file containing
|
@@ -9434,18 +9314,9 @@ module Aws::GameLift
|
|
9434
9314
|
#
|
9435
9315
|
# ^
|
9436
9316
|
#
|
9437
|
-
# **Related actions**
|
9438
|
-
#
|
9439
|
-
# CreateMatchmakingConfiguration \| DescribeMatchmakingConfigurations \|
|
9440
|
-
# UpdateMatchmakingConfiguration \| DeleteMatchmakingConfiguration \|
|
9441
|
-
# CreateMatchmakingRuleSet \| DescribeMatchmakingRuleSets \|
|
9442
|
-
# ValidateMatchmakingRuleSet \| DeleteMatchmakingRuleSet \| [All APIs by
|
9443
|
-
# task][2]
|
9444
|
-
#
|
9445
9317
|
#
|
9446
9318
|
#
|
9447
9319
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
9448
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
9449
9320
|
#
|
9450
9321
|
# @option params [required, String] :rule_set_body
|
9451
9322
|
# A collection of matchmaking rules to validate, formatted as a JSON
|
@@ -9487,7 +9358,7 @@ module Aws::GameLift
|
|
9487
9358
|
params: params,
|
9488
9359
|
config: config)
|
9489
9360
|
context[:gem_name] = 'aws-sdk-gamelift'
|
9490
|
-
context[:gem_version] = '1.
|
9361
|
+
context[:gem_version] = '1.60.0'
|
9491
9362
|
Seahorse::Client::Request.new(handlers, context)
|
9492
9363
|
end
|
9493
9364
|
|