aws-sdk-gamelift 1.53.0 → 1.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gamelift/client.rb +602 -485
- data/lib/aws-sdk-gamelift/types.rb +558 -416
- data/lib/aws-sdk-gamelift.rb +1 -1
- metadata +2 -2
@@ -545,12 +545,12 @@ module Aws::GameLift
|
|
545
545
|
# for a fleet that is useful when redirecting player traffic from one
|
546
546
|
# fleet to another, such as when updating your game build.
|
547
547
|
#
|
548
|
-
# Amazon
|
549
|
-
# simple and terminal. A simple alias points to an active
|
550
|
-
# terminal alias is used to display messaging or link to a URL
|
551
|
-
# of routing players to an active fleet. For example, you might
|
552
|
-
# terminal alias when a game version is no longer supported and
|
553
|
-
# to direct players to an upgrade site.
|
548
|
+
# Amazon Web Services supports two types of routing strategies for
|
549
|
+
# aliases: simple and terminal. A simple alias points to an active
|
550
|
+
# fleet. A terminal alias is used to display messaging or link to a URL
|
551
|
+
# instead of routing players to an active fleet. For example, you might
|
552
|
+
# use a terminal alias when a game version is no longer supported and
|
553
|
+
# you want to direct players to an upgrade site.
|
554
554
|
#
|
555
555
|
# To create a fleet alias, specify an alias name, routing strategy, and
|
556
556
|
# optional description. Each simple alias can point to only one fleet,
|
@@ -580,12 +580,13 @@ module Aws::GameLift
|
|
580
580
|
#
|
581
581
|
# @option params [Array<Types::Tag>] :tags
|
582
582
|
# A list of labels to assign to the new alias resource. Tags are
|
583
|
-
# developer-defined key-value pairs. Tagging
|
584
|
-
# for resource management, access management and
|
585
|
-
# more information, see [ Tagging
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
583
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
584
|
+
# resources are useful for resource management, access management and
|
585
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
586
|
+
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
587
|
+
# Once the resource is created, you can use TagResource, UntagResource,
|
588
|
+
# and ListTagsForResource to add, remove, and view tags. The maximum tag
|
589
|
+
# limit may be lower than stated. See the Amazon Web Services General
|
589
590
|
# Reference for actual tagging limits.
|
590
591
|
#
|
591
592
|
#
|
@@ -635,12 +636,12 @@ module Aws::GameLift
|
|
635
636
|
req.send_request(options)
|
636
637
|
end
|
637
638
|
|
638
|
-
# Creates a new Amazon
|
639
|
+
# Creates a new Amazon Web Services build resource for your game server
|
639
640
|
# binary files. Game server binaries must be combined into a zip file
|
640
|
-
# for use with Amazon
|
641
|
+
# for use with Amazon Web Services.
|
641
642
|
#
|
642
643
|
# When setting up a new game build for GameLift, we recommend using the
|
643
|
-
#
|
644
|
+
# Amazon Web Services CLI command <b> <a
|
644
645
|
# href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
645
646
|
# </b>. This helper command combines two tasks: (1) it uploads your
|
646
647
|
# build files from a file directory to a GameLift Amazon S3 location,
|
@@ -649,11 +650,11 @@ module Aws::GameLift
|
|
649
650
|
# The `CreateBuild` operation can used in the following scenarios:
|
650
651
|
#
|
651
652
|
# * To create a new game build with build files that are in an Amazon S3
|
652
|
-
# location under an
|
653
|
-
# you must first give Amazon
|
654
|
-
# With permissions in place, call `CreateBuild`
|
655
|
-
# name, operating system, and the Amazon S3
|
656
|
-
# game build.
|
653
|
+
# location under an Amazon Web Services account that you control. To
|
654
|
+
# use this option, you must first give Amazon Web Services access to
|
655
|
+
# the Amazon S3 bucket. With permissions in place, call `CreateBuild`
|
656
|
+
# and specify a build name, operating system, and the Amazon S3
|
657
|
+
# storage location of your game build.
|
657
658
|
#
|
658
659
|
# * To directly upload your build files to a GameLift Amazon S3
|
659
660
|
# location. To use this option, first call `CreateBuild` and specify a
|
@@ -702,8 +703,13 @@ module Aws::GameLift
|
|
702
703
|
# this parameter only when creating a build with files stored in an
|
703
704
|
# Amazon S3 bucket that you own. The storage location must specify an
|
704
705
|
# Amazon S3 bucket name and key. The location must also specify a role
|
705
|
-
# ARN that you set up to allow Amazon
|
706
|
-
# bucket. The S3 bucket and your new build must be in the same
|
706
|
+
# ARN that you set up to allow Amazon Web Services to access your Amazon
|
707
|
+
# S3 bucket. The S3 bucket and your new build must be in the same
|
708
|
+
# Region.
|
709
|
+
#
|
710
|
+
# If a `StorageLocation` is specified, the size of your file can be
|
711
|
+
# found in your Amazon S3 bucket. Amazon Web Services will report a
|
712
|
+
# `SizeOnDisk` of 0.
|
707
713
|
#
|
708
714
|
# @option params [String] :operating_system
|
709
715
|
# The operating system that the game server binaries are built to run
|
@@ -715,12 +721,13 @@ module Aws::GameLift
|
|
715
721
|
#
|
716
722
|
# @option params [Array<Types::Tag>] :tags
|
717
723
|
# A list of labels to assign to the new build resource. Tags are
|
718
|
-
# developer-defined key-value pairs. Tagging
|
719
|
-
# for resource management, access management and
|
720
|
-
# more information, see [ Tagging
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
725
|
+
# resources are useful for resource management, access management and
|
726
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
727
|
+
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
728
|
+
# Once the resource is created, you can use TagResource, UntagResource,
|
729
|
+
# and ListTagsForResource to add, remove, and view tags. The maximum tag
|
730
|
+
# limit may be lower than stated. See the Amazon Web Services General
|
724
731
|
# Reference for actual tagging limits.
|
725
732
|
#
|
726
733
|
#
|
@@ -780,21 +787,23 @@ module Aws::GameLift
|
|
780
787
|
req.send_request(options)
|
781
788
|
end
|
782
789
|
|
783
|
-
# Creates a fleet of Amazon Elastic Compute Cloud (Amazon
|
784
|
-
# to host your custom game server or Realtime
|
785
|
-
# operation to configure the computing resources for
|
786
|
-
# provide instructions for running game servers on each
|
790
|
+
# Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic
|
791
|
+
# Compute Cloud) instances to host your custom game server or Realtime
|
792
|
+
# Servers. Use this operation to configure the computing resources for
|
793
|
+
# your fleet and provide instructions for running game servers on each
|
794
|
+
# instance.
|
787
795
|
#
|
788
796
|
# Most GameLift fleets can deploy instances to multiple locations,
|
789
797
|
# including the home Region (where the fleet is created) and an optional
|
790
|
-
# set of remote locations. Fleets that are created in the following
|
791
|
-
# Regions support multiple locations: us-east-1 (N.
|
792
|
-
# (Oregon), eu-central-1 (Frankfurt), eu-west-1
|
793
|
-
# ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and
|
794
|
-
# (Seoul). Fleets that are created in other GameLift
|
795
|
-
# instances in the fleet's home Region only. All
|
796
|
-
# the same configuration regardless of location;
|
797
|
-
# capacity settings and turn auto-scaling on/off
|
798
|
+
# set of remote locations. Fleets that are created in the following
|
799
|
+
# Amazon Web Services Regions support multiple locations: us-east-1 (N.
|
800
|
+
# Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1
|
801
|
+
# (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and
|
802
|
+
# ap-northeast-2 (Seoul). Fleets that are created in other GameLift
|
803
|
+
# Regions can deploy instances in the fleet's home Region only. All
|
804
|
+
# fleet instances use the same configuration regardless of location;
|
805
|
+
# however, you can adjust capacity settings and turn auto-scaling on/off
|
806
|
+
# for each location.
|
798
807
|
#
|
799
808
|
# To create a fleet, choose the hardware for your instances, specify a
|
800
809
|
# game server build or Realtime script to deploy, and provide a runtime
|
@@ -804,6 +813,12 @@ module Aws::GameLift
|
|
804
813
|
# creating a multi-location fleet, provide a list of additional remote
|
805
814
|
# locations.
|
806
815
|
#
|
816
|
+
# If you need to debug your fleet, fetch logs, view performance metrics
|
817
|
+
# or other actions on the fleet, create the development fleet with port
|
818
|
+
# 22/3389 open. As a best practice, we recommend opening ports for
|
819
|
+
# remote access only when you need them and closing them when you're
|
820
|
+
# finished.
|
821
|
+
#
|
807
822
|
# If successful, this operation creates a new Fleet resource and places
|
808
823
|
# it in `NEW` status, which prompts GameLift to initiate the [fleet
|
809
824
|
# creation workflow][1]. You can track fleet creation by checking fleet
|
@@ -878,11 +893,11 @@ module Aws::GameLift
|
|
878
893
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process
|
879
894
|
#
|
880
895
|
# @option params [required, String] :ec2_instance_type
|
881
|
-
# The GameLift-supported EC2 instance type to use for all fleet
|
896
|
+
# The GameLift-supported Amazon EC2 instance type to use for all fleet
|
882
897
|
# instances. Instance type determines the computing resources that will
|
883
898
|
# be used to host your game servers, including CPU, memory, storage, and
|
884
|
-
# networking capacity. See [Amazon
|
885
|
-
# descriptions of EC2 instance types.
|
899
|
+
# networking capacity. See [Amazon Elastic Compute Cloud Instance
|
900
|
+
# Types][1] for detailed descriptions of Amazon EC2 instance types.
|
886
901
|
#
|
887
902
|
#
|
888
903
|
#
|
@@ -927,23 +942,24 @@ module Aws::GameLift
|
|
927
942
|
# of time.
|
928
943
|
#
|
929
944
|
# @option params [Array<String>] :metric_groups
|
930
|
-
# The name of an
|
931
|
-
# metric group is used to aggregate the metrics for multiple
|
932
|
-
# can specify an existing metric group name or set a new
|
933
|
-
# a new metric group. A fleet can be included in only one
|
934
|
-
# at a time.
|
945
|
+
# The name of an Amazon Web Services CloudWatch metric group to add this
|
946
|
+
# fleet to. A metric group is used to aggregate the metrics for multiple
|
947
|
+
# fleets. You can specify an existing metric group name or set a new
|
948
|
+
# name to create a new metric group. A fleet can be included in only one
|
949
|
+
# metric group at a time.
|
935
950
|
#
|
936
951
|
# @option params [String] :peer_vpc_aws_account_id
|
937
952
|
# Used when peering your GameLift fleet with a VPC, the unique
|
938
|
-
# identifier for the
|
939
|
-
# account ID in the
|
953
|
+
# identifier for the Amazon Web Services account that owns the VPC. You
|
954
|
+
# can find your account ID in the Amazon Web Services Management Console
|
955
|
+
# under account settings.
|
940
956
|
#
|
941
957
|
# @option params [String] :peer_vpc_id
|
942
958
|
# A unique identifier for a VPC with resources to be accessed by your
|
943
959
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
944
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
945
|
-
# Console. Learn more about VPC peering in [VPC
|
946
|
-
# Fleets][2].
|
960
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
961
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
962
|
+
# Peering with GameLift Fleets][2].
|
947
963
|
#
|
948
964
|
#
|
949
965
|
#
|
@@ -961,15 +977,15 @@ module Aws::GameLift
|
|
961
977
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot
|
962
978
|
#
|
963
979
|
# @option params [String] :instance_role_arn
|
964
|
-
# A unique identifier for an
|
965
|
-
#
|
966
|
-
# on an instance in this fleet can assume the role, including
|
967
|
-
# scripts, server processes, and daemons (background processes).
|
968
|
-
# a role or look up a role's ARN by using the [IAM dashboard][1]
|
969
|
-
#
|
970
|
-
# your game servers at [ Access external
|
971
|
-
# server][2]. This property cannot be changed
|
972
|
-
# created.
|
980
|
+
# A unique identifier for an IAM role that manages access to your Amazon
|
981
|
+
# Web Services services. With an instance role ARN set, any application
|
982
|
+
# that runs on an instance in this fleet can assume the role, including
|
983
|
+
# install scripts, server processes, and daemons (background processes).
|
984
|
+
# Create a role or look up a role's ARN by using the [IAM dashboard][1]
|
985
|
+
# in the Amazon Web Services Management Console. Learn more about using
|
986
|
+
# on-box credentials for your game servers at [ Access external
|
987
|
+
# resources from a game server][2]. This property cannot be changed
|
988
|
+
# after the fleet is created.
|
973
989
|
#
|
974
990
|
#
|
975
991
|
#
|
@@ -980,35 +996,33 @@ module Aws::GameLift
|
|
980
996
|
# Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS
|
981
997
|
# certificates are used for encrypting traffic between game clients and
|
982
998
|
# the game servers that are running on GameLift. By default, the
|
983
|
-
# `CertificateConfiguration` is set to `DISABLED`.
|
984
|
-
#
|
985
|
-
# changed after the fleet is created.
|
986
|
-
#
|
987
|
-
# Note: This feature requires the AWS Certificate Manager (ACM) service,
|
988
|
-
# which is not available in all AWS regions. When working in a region
|
989
|
-
# that does not support this feature, a fleet creation request with
|
990
|
-
# certificate generation fails with a 4xx error.
|
999
|
+
# `CertificateConfiguration` is set to `DISABLED`. This property cannot
|
1000
|
+
# be changed after the fleet is created.
|
991
1001
|
#
|
992
|
-
#
|
993
|
-
#
|
994
|
-
#
|
1002
|
+
# Note: This feature requires the Amazon Web Services Certificate
|
1003
|
+
# Manager (ACM) service, which is not available in all Amazon Web
|
1004
|
+
# Services regions. When working in a region that does not support this
|
1005
|
+
# feature, a fleet creation request with certificate generation fails
|
1006
|
+
# with a 4xx error.
|
995
1007
|
#
|
996
1008
|
# @option params [Array<Types::LocationConfiguration>] :locations
|
997
1009
|
# A set of remote locations to deploy additional instances to and manage
|
998
1010
|
# as part of the fleet. This parameter can only be used when creating
|
999
|
-
# fleets in
|
1000
|
-
# GameLift-supported
|
1001
|
-
#
|
1002
|
-
#
|
1011
|
+
# fleets in Amazon Web Services Regions that support multiple locations.
|
1012
|
+
# You can add any GameLift-supported Amazon Web Services Region as a
|
1013
|
+
# remote location, in the form of an Amazon Web Services Region code
|
1014
|
+
# such as `us-west-2`. To create a fleet with instances in the home
|
1015
|
+
# Region only, omit this parameter.
|
1003
1016
|
#
|
1004
1017
|
# @option params [Array<Types::Tag>] :tags
|
1005
1018
|
# A list of labels to assign to the new fleet resource. Tags are
|
1006
|
-
# developer-defined key-value pairs. Tagging
|
1007
|
-
# for resource management, access management and
|
1008
|
-
# more information, see [ Tagging
|
1009
|
-
#
|
1010
|
-
#
|
1011
|
-
#
|
1019
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
1020
|
+
# resources are useful for resource management, access management and
|
1021
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
1022
|
+
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
1023
|
+
# Once the fleet is created, you can use TagResource, UntagResource, and
|
1024
|
+
# ListTagsForResource to add, remove, and view tags. The maximum tag
|
1025
|
+
# limit may be lower than stated. See the *Amazon Web Services General
|
1012
1026
|
# Reference* for actual tagging limits.
|
1013
1027
|
#
|
1014
1028
|
#
|
@@ -1125,9 +1139,9 @@ module Aws::GameLift
|
|
1125
1139
|
#
|
1126
1140
|
# <note markdown="1"> This operation cannot be used with fleets that don't support remote
|
1127
1141
|
# locations. Fleets can have multiple locations only if they reside in
|
1128
|
-
#
|
1129
|
-
# complete list) and were created after the feature was released
|
1130
|
-
# March 2021.
|
1142
|
+
# Amazon Web Services Regions that support this feature (see CreateFleet
|
1143
|
+
# for the complete list) and were created after the feature was released
|
1144
|
+
# in March 2021.
|
1131
1145
|
#
|
1132
1146
|
# </note>
|
1133
1147
|
#
|
@@ -1168,9 +1182,9 @@ module Aws::GameLift
|
|
1168
1182
|
#
|
1169
1183
|
# @option params [required, Array<Types::LocationConfiguration>] :locations
|
1170
1184
|
# A list of locations to deploy additional instances to and manage as
|
1171
|
-
# part of the fleet. You can add any GameLift-supported
|
1172
|
-
# remote location, in the form of an
|
1173
|
-
# `us-west-2`.
|
1185
|
+
# part of the fleet. You can add any GameLift-supported Amazon Web
|
1186
|
+
# Services Region as a remote location, in the form of an Amazon Web
|
1187
|
+
# Services Region code such as `us-west-2`.
|
1174
1188
|
#
|
1175
1189
|
# @return [Types::CreateFleetLocationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1176
1190
|
#
|
@@ -1210,31 +1224,33 @@ module Aws::GameLift
|
|
1210
1224
|
# server groups.**
|
1211
1225
|
#
|
1212
1226
|
# Creates a GameLift FleetIQ game server group for managing game hosting
|
1213
|
-
# on a collection of Amazon
|
1214
|
-
# operation creates the game server group, creates an Auto
|
1215
|
-
# in your
|
1216
|
-
# You can view the status of your game
|
1217
|
-
# console. Game server group metrics and
|
1218
|
-
# CloudWatch.
|
1227
|
+
# on a collection of Amazon Elastic Compute Cloud instances for game
|
1228
|
+
# hosting. This operation creates the game server group, creates an Auto
|
1229
|
+
# Scaling group in your Amazon Web Services account, and establishes a
|
1230
|
+
# link between the two groups. You can view the status of your game
|
1231
|
+
# server groups in the GameLift console. Game server group metrics and
|
1232
|
+
# events are emitted to Amazon CloudWatch.
|
1219
1233
|
#
|
1220
1234
|
# Before creating a new game server group, you must have the following:
|
1221
1235
|
#
|
1222
|
-
# * An Amazon
|
1223
|
-
#
|
1224
|
-
#
|
1225
|
-
#
|
1236
|
+
# * An Amazon Elastic Compute Cloud launch template that specifies how
|
1237
|
+
# to launch Amazon Elastic Compute Cloud instances with your game
|
1238
|
+
# server build. For more information, see [ Launching an Instance from
|
1239
|
+
# a Launch Template][1] in the *Amazon Elastic Compute Cloud User
|
1240
|
+
# Guide*.
|
1226
1241
|
#
|
1227
|
-
# * An IAM role that extends limited access to your
|
1228
|
-
# GameLift FleetIQ to create and interact with the
|
1229
|
-
# For more information, see [Create IAM roles for
|
1230
|
-
# interaction][2] in the *GameLift FleetIQ Developer
|
1242
|
+
# * An IAM role that extends limited access to your Amazon Web Services
|
1243
|
+
# account to allow GameLift FleetIQ to create and interact with the
|
1244
|
+
# Auto Scaling group. For more information, see [Create IAM roles for
|
1245
|
+
# cross-service interaction][2] in the *GameLift FleetIQ Developer
|
1246
|
+
# Guide*.
|
1231
1247
|
#
|
1232
1248
|
# To create a new game server group, specify a unique group name, IAM
|
1233
|
-
# role and Amazon
|
1234
|
-
# types that can be used in the group. You must also
|
1235
|
-
# and minimum limits on the group's instance count.
|
1236
|
-
# set an Auto Scaling policy with target tracking
|
1237
|
-
# FleetIQ metric.
|
1249
|
+
# role and Amazon Elastic Compute Cloud launch template, and provide a
|
1250
|
+
# list of instance types that can be used in the group. You must also
|
1251
|
+
# set initial maximum and minimum limits on the group's instance count.
|
1252
|
+
# You can optionally set an Auto Scaling policy with target tracking
|
1253
|
+
# based on a GameLift FleetIQ metric.
|
1238
1254
|
#
|
1239
1255
|
# Once the game server group and corresponding Auto Scaling group are
|
1240
1256
|
# created, you have full access to change the Auto Scaling group's
|
@@ -1266,41 +1282,42 @@ module Aws::GameLift
|
|
1266
1282
|
#
|
1267
1283
|
# @option params [required, String] :game_server_group_name
|
1268
1284
|
# An identifier for the new game server group. This value is used to
|
1269
|
-
# generate unique ARN identifiers for the EC2 Auto Scaling group
|
1270
|
-
# GameLift FleetIQ game server group. The name must be unique
|
1271
|
-
# per
|
1285
|
+
# generate unique ARN identifiers for the Amazon EC2 Auto Scaling group
|
1286
|
+
# and the GameLift FleetIQ game server group. The name must be unique
|
1287
|
+
# per Region per Amazon Web Services account.
|
1272
1288
|
#
|
1273
1289
|
# @option params [required, String] :role_arn
|
1274
1290
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
1275
|
-
#
|
1291
|
+
# Web Services to access your Amazon EC2 Auto Scaling groups.
|
1276
1292
|
#
|
1277
1293
|
#
|
1278
1294
|
#
|
1279
1295
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
1280
1296
|
#
|
1281
1297
|
# @option params [required, Integer] :min_size
|
1282
|
-
# The minimum number of instances allowed in the EC2 Auto Scaling
|
1283
|
-
# During automatic scaling events, GameLift FleetIQ and
|
1284
|
-
# down the group below this minimum. In production,
|
1285
|
-
# set to at least 1. After the Auto Scaling group
|
1286
|
-
# this value directly in the Auto Scaling group using
|
1287
|
-
# APIs.
|
1298
|
+
# The minimum number of instances allowed in the Amazon EC2 Auto Scaling
|
1299
|
+
# group. During automatic scaling events, GameLift FleetIQ and Amazon
|
1300
|
+
# EC2 do not scale down the group below this minimum. In production,
|
1301
|
+
# this value should be set to at least 1. After the Auto Scaling group
|
1302
|
+
# is created, update this value directly in the Auto Scaling group using
|
1303
|
+
# the Amazon Web Services console or APIs.
|
1288
1304
|
#
|
1289
1305
|
# @option params [required, Integer] :max_size
|
1290
|
-
# The maximum number of instances allowed in the EC2 Auto Scaling
|
1291
|
-
# During automatic scaling events, GameLift FleetIQ and EC2 do
|
1292
|
-
# up the group above this maximum. After the Auto Scaling
|
1293
|
-
# created, update this value directly in the Auto Scaling group
|
1294
|
-
# the
|
1306
|
+
# The maximum number of instances allowed in the Amazon EC2 Auto Scaling
|
1307
|
+
# group. During automatic scaling events, GameLift FleetIQ and EC2 do
|
1308
|
+
# not scale up the group above this maximum. After the Auto Scaling
|
1309
|
+
# group is created, update this value directly in the Auto Scaling group
|
1310
|
+
# using the Amazon Web Services console or APIs.
|
1295
1311
|
#
|
1296
1312
|
# @option params [required, Types::LaunchTemplateSpecification] :launch_template
|
1297
|
-
# The EC2 launch template that contains configuration settings
|
1298
|
-
# server code to be deployed to all instances in the game
|
1299
|
-
# You can specify the template using either the template
|
1300
|
-
# help with creating a launch template, see [Creating a
|
1301
|
-
# for an Auto Scaling Group][1] in the *Amazon
|
1302
|
-
# Guide*. After the Auto Scaling group
|
1303
|
-
# directly in the Auto Scaling group using
|
1313
|
+
# The Amazon EC2 launch template that contains configuration settings
|
1314
|
+
# and game server code to be deployed to all instances in the game
|
1315
|
+
# server group. You can specify the template using either the template
|
1316
|
+
# name or ID. For help with creating a launch template, see [Creating a
|
1317
|
+
# Launch Template for an Auto Scaling Group][1] in the *Amazon Elastic
|
1318
|
+
# Compute Cloud Auto Scaling User Guide*. After the Auto Scaling group
|
1319
|
+
# is created, update this value directly in the Auto Scaling group using
|
1320
|
+
# the Amazon Web Services console or APIs.
|
1304
1321
|
#
|
1305
1322
|
# <note markdown="1"> If you specify network interfaces in your launch template, you must
|
1306
1323
|
# explicitly set the property `AssociatePublicIpAddress` to "true". If
|
@@ -1314,15 +1331,16 @@ module Aws::GameLift
|
|
1314
1331
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
1315
1332
|
#
|
1316
1333
|
# @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
|
1317
|
-
# The EC2 instance types and sizes to use in the Auto Scaling
|
1318
|
-
# instance definitions must specify at least two different
|
1319
|
-
# types that are supported by GameLift FleetIQ. For more
|
1320
|
-
# instance types, see [EC2 Instance Types][1] in the
|
1321
|
-
# Guide*. You can optionally specify
|
1322
|
-
# instance type. If no weight value is
|
1323
|
-
# it is set to the default value "1".
|
1324
|
-
# capacity weighting, see [ Instance
|
1325
|
-
# Scaling][2] in the Amazon EC2 Auto
|
1334
|
+
# The Amazon EC2 instance types and sizes to use in the Auto Scaling
|
1335
|
+
# group. The instance definitions must specify at least two different
|
1336
|
+
# instance types that are supported by GameLift FleetIQ. For more
|
1337
|
+
# information on instance types, see [EC2 Instance Types][1] in the
|
1338
|
+
# *Amazon Elastic Compute Cloud User Guide*. You can optionally specify
|
1339
|
+
# capacity weighting for each instance type. If no weight value is
|
1340
|
+
# specified for an instance type, it is set to the default value "1".
|
1341
|
+
# For more information about capacity weighting, see [ Instance
|
1342
|
+
# Weighting for Amazon EC2 Auto Scaling][2] in the Amazon EC2 Auto
|
1343
|
+
# Scaling User Guide.
|
1326
1344
|
#
|
1327
1345
|
#
|
1328
1346
|
#
|
@@ -1335,7 +1353,7 @@ module Aws::GameLift
|
|
1335
1353
|
# metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
|
1336
1354
|
# game servers that can immediately accommodate new games and players.
|
1337
1355
|
# After the Auto Scaling group is created, update this value directly in
|
1338
|
-
# the Auto Scaling group using the
|
1356
|
+
# the Auto Scaling group using the Amazon Web Services console or APIs.
|
1339
1357
|
#
|
1340
1358
|
# @option params [String] :balancing_strategy
|
1341
1359
|
# Indicates how GameLift FleetIQ balances the use of Spot Instances and
|
@@ -1368,8 +1386,8 @@ module Aws::GameLift
|
|
1368
1386
|
# instances cannot be terminated while there are active game servers
|
1369
1387
|
# running except in the event of a forced game server group deletion
|
1370
1388
|
# (see ). An exception to this is with Spot Instances, which can be
|
1371
|
-
# terminated by
|
1372
|
-
# set to `NO_PROTECTION` by default.
|
1389
|
+
# terminated by Amazon Web Services regardless of protection status.
|
1390
|
+
# This property is set to `NO_PROTECTION` by default.
|
1373
1391
|
#
|
1374
1392
|
# @option params [Array<String>] :vpc_subnets
|
1375
1393
|
# A list of virtual private cloud (VPC) subnets to use with instances in
|
@@ -1382,13 +1400,14 @@ module Aws::GameLift
|
|
1382
1400
|
#
|
1383
1401
|
# @option params [Array<Types::Tag>] :tags
|
1384
1402
|
# A list of labels to assign to the new game server group resource. Tags
|
1385
|
-
# are developer-defined key-value pairs. Tagging
|
1386
|
-
# for resource management, access management, and
|
1387
|
-
# more information, see [ Tagging
|
1388
|
-
#
|
1389
|
-
#
|
1390
|
-
#
|
1391
|
-
#
|
1403
|
+
# are developer-defined key-value pairs. Tagging Amazon Web Services
|
1404
|
+
# resources is useful for resource management, access management, and
|
1405
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
1406
|
+
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
1407
|
+
# Once the resource is created, you can use TagResource, UntagResource,
|
1408
|
+
# and ListTagsForResource to add, remove, and view tags, respectively.
|
1409
|
+
# The maximum tag limit may be lower than stated. See the Amazon Web
|
1410
|
+
# Services General Reference for actual tagging limits.
|
1392
1411
|
#
|
1393
1412
|
#
|
1394
1413
|
#
|
@@ -1497,7 +1516,7 @@ module Aws::GameLift
|
|
1497
1516
|
# days. To access the logs, call GetGameSessionLogUrl to download the
|
1498
1517
|
# log files.
|
1499
1518
|
#
|
1500
|
-
# *Available in
|
1519
|
+
# *Available in Amazon Web Services Local.*
|
1501
1520
|
#
|
1502
1521
|
# **Learn more**
|
1503
1522
|
#
|
@@ -1537,7 +1556,12 @@ module Aws::GameLift
|
|
1537
1556
|
# @option params [Array<Types::GameProperty>] :game_properties
|
1538
1557
|
# A set of custom properties for a game session, formatted as key:value
|
1539
1558
|
# pairs. These properties are passed to a game server process in the
|
1540
|
-
# GameSession object with a request to start a new game session
|
1559
|
+
# GameSession object with a request to start a new game session (see
|
1560
|
+
# [Start a Game Session][1]).
|
1561
|
+
#
|
1562
|
+
#
|
1563
|
+
#
|
1564
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1541
1565
|
#
|
1542
1566
|
# @option params [String] :creator_id
|
1543
1567
|
# A unique identifier for a player or entity creating the game session.
|
@@ -1569,13 +1593,18 @@ module Aws::GameLift
|
|
1569
1593
|
# @option params [String] :game_session_data
|
1570
1594
|
# A set of custom game session properties, formatted as a single string
|
1571
1595
|
# value. This data is passed to a game server process in the GameSession
|
1572
|
-
# object with a request to start a new game session
|
1596
|
+
# object with a request to start a new game session (see [Start a Game
|
1597
|
+
# Session][1]).
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
#
|
1601
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
|
1573
1602
|
#
|
1574
1603
|
# @option params [String] :location
|
1575
1604
|
# A fleet's remote location to place the new game session in. If this
|
1576
1605
|
# parameter is not set, the new game session is placed in the fleet's
|
1577
|
-
# home Region. Specify a remote location with an
|
1578
|
-
# `us-west-2`.
|
1606
|
+
# home Region. Specify a remote location with an Amazon Web Services
|
1607
|
+
# Region code such as `us-west-2`.
|
1579
1608
|
#
|
1580
1609
|
# @return [Types::CreateGameSessionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1581
1610
|
#
|
@@ -1642,10 +1671,10 @@ module Aws::GameLift
|
|
1642
1671
|
# A game session queue is configured with a set of destinations
|
1643
1672
|
# (GameLift fleets or aliases), which determine the locations where the
|
1644
1673
|
# queue can place new game sessions. These destinations can span
|
1645
|
-
# multiple fleet types (Spot and On-Demand), instance types, and
|
1646
|
-
# Regions. If the queue includes multi-location fleets, the
|
1647
|
-
# able to place game sessions in all of a fleet's remote
|
1648
|
-
# can opt to filter out individual locations if needed.
|
1674
|
+
# multiple fleet types (Spot and On-Demand), instance types, and Amazon
|
1675
|
+
# Web Services Regions. If the queue includes multi-location fleets, the
|
1676
|
+
# queue is able to place game sessions in all of a fleet's remote
|
1677
|
+
# locations. You can opt to filter out individual locations if needed.
|
1649
1678
|
#
|
1650
1679
|
# The queue configuration also determines how FleetIQ selects the best
|
1651
1680
|
# available placement for a new game session. Before searching for an
|
@@ -1664,26 +1693,32 @@ module Aws::GameLift
|
|
1664
1693
|
#
|
1665
1694
|
# If successful, a new `GameSessionQueue` object is returned with an
|
1666
1695
|
# assigned queue ARN. New game session requests, which are submitted to
|
1667
|
-
#
|
1696
|
+
# queue with [StartGameSessionPlacement][1] or [StartMatchmaking][2],
|
1668
1697
|
# reference a queue's name or ARN.
|
1669
1698
|
#
|
1670
1699
|
# **Learn more**
|
1671
1700
|
#
|
1672
|
-
# [ Design a game session queue][
|
1701
|
+
# [ Design a game session queue][3]
|
1673
1702
|
#
|
1674
|
-
# [ Create a game session queue][
|
1703
|
+
# [ Create a game session queue][4]
|
1675
1704
|
#
|
1676
1705
|
# **Related actions**
|
1677
1706
|
#
|
1678
|
-
# CreateGameSessionQueue \| DescribeGameSessionQueues \|
|
1679
|
-
# UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All
|
1680
|
-
# task][
|
1707
|
+
# [CreateGameSessionQueue][5] \| [DescribeGameSessionQueues][6] \|
|
1708
|
+
# [UpdateGameSessionQueue][7] \| [DeleteGameSessionQueue][8] \| [All
|
1709
|
+
# APIs by task][9]
|
1681
1710
|
#
|
1682
1711
|
#
|
1683
1712
|
#
|
1684
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
1685
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
1686
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
1713
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html
|
1714
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html
|
1715
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html
|
1716
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html
|
1717
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
1718
|
+
# [6]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
1719
|
+
# [7]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
1720
|
+
# [8]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
1721
|
+
# [9]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
1687
1722
|
#
|
1688
1723
|
# @option params [required, String] :name
|
1689
1724
|
# A descriptive label that is associated with game session queue. Queue
|
@@ -1711,9 +1746,9 @@ module Aws::GameLift
|
|
1711
1746
|
#
|
1712
1747
|
# @option params [Types::FilterConfiguration] :filter_configuration
|
1713
1748
|
# A list of locations where a queue is allowed to place new game
|
1714
|
-
# sessions. Locations are specified in the form of
|
1715
|
-
# such as `us-west-2`. If this parameter is not set, game
|
1716
|
-
# be placed in any queue location.
|
1749
|
+
# sessions. Locations are specified in the form of Amazon Web Services
|
1750
|
+
# Region codes, such as `us-west-2`. If this parameter is not set, game
|
1751
|
+
# sessions can be placed in any queue location.
|
1717
1752
|
#
|
1718
1753
|
# @option params [Types::PriorityConfiguration] :priority_configuration
|
1719
1754
|
# Custom settings to use when prioritizing destinations and locations
|
@@ -1737,13 +1772,14 @@ module Aws::GameLift
|
|
1737
1772
|
#
|
1738
1773
|
# @option params [Array<Types::Tag>] :tags
|
1739
1774
|
# A list of labels to assign to the new game session queue resource.
|
1740
|
-
# Tags are developer-defined key-value pairs. Tagging
|
1741
|
-
# useful for resource management, access
|
1742
|
-
# For more information, see [ Tagging
|
1743
|
-
#
|
1744
|
-
#
|
1745
|
-
# and
|
1746
|
-
#
|
1775
|
+
# Tags are developer-defined key-value pairs. Tagging Amazon Web
|
1776
|
+
# Services resources are useful for resource management, access
|
1777
|
+
# management and cost allocation. For more information, see [ Tagging
|
1778
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
1779
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
1780
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
1781
|
+
# The maximum tag limit may be lower than stated. See the Amazon Web
|
1782
|
+
# Services General Reference for actual tagging limits.
|
1747
1783
|
#
|
1748
1784
|
#
|
1749
1785
|
#
|
@@ -1834,10 +1870,10 @@ module Aws::GameLift
|
|
1834
1870
|
# queue to use when starting a game session for the match.
|
1835
1871
|
#
|
1836
1872
|
# In addition, you must set up an Amazon Simple Notification Service
|
1837
|
-
#
|
1838
|
-
#
|
1839
|
-
#
|
1840
|
-
#
|
1873
|
+
# topic to receive matchmaking notifications. Provide the topic ARN in
|
1874
|
+
# the matchmaking configuration. An alternative method, continuously
|
1875
|
+
# polling ticket status with DescribeMatchmaking, is only suitable for
|
1876
|
+
# games in development with low matchmaking usage.
|
1841
1877
|
#
|
1842
1878
|
# **Learn more**
|
1843
1879
|
#
|
@@ -1978,13 +2014,14 @@ module Aws::GameLift
|
|
1978
2014
|
#
|
1979
2015
|
# @option params [Array<Types::Tag>] :tags
|
1980
2016
|
# A list of labels to assign to the new matchmaking configuration
|
1981
|
-
# resource. Tags are developer-defined key-value pairs. Tagging
|
1982
|
-
# resources are useful for resource management, access
|
1983
|
-
# cost allocation. For more information, see [ Tagging
|
1984
|
-
#
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
#
|
2017
|
+
# resource. Tags are developer-defined key-value pairs. Tagging Amazon
|
2018
|
+
# Web Services resources are useful for resource management, access
|
2019
|
+
# management and cost allocation. For more information, see [ Tagging
|
2020
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
2021
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
2022
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
2023
|
+
# The maximum tag limit may be lower than stated. See the Amazon Web
|
2024
|
+
# Services General Reference for actual tagging limits.
|
1988
2025
|
#
|
1989
2026
|
#
|
1990
2027
|
#
|
@@ -2106,13 +2143,14 @@ module Aws::GameLift
|
|
2106
2143
|
#
|
2107
2144
|
# @option params [Array<Types::Tag>] :tags
|
2108
2145
|
# A list of labels to assign to the new matchmaking rule set resource.
|
2109
|
-
# Tags are developer-defined key-value pairs. Tagging
|
2110
|
-
# useful for resource management, access
|
2111
|
-
# For more information, see [ Tagging
|
2112
|
-
#
|
2113
|
-
#
|
2114
|
-
# and
|
2115
|
-
#
|
2146
|
+
# Tags are developer-defined key-value pairs. Tagging Amazon Web
|
2147
|
+
# Services resources are useful for resource management, access
|
2148
|
+
# management and cost allocation. For more information, see [ Tagging
|
2149
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
2150
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
2151
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
2152
|
+
# The maximum tag limit may be lower than stated. See the Amazon Web
|
2153
|
+
# Services General Reference for actual tagging limits.
|
2116
2154
|
#
|
2117
2155
|
#
|
2118
2156
|
#
|
@@ -2167,7 +2205,10 @@ module Aws::GameLift
|
|
2167
2205
|
# validate the player reservation with the GameLift service. Player
|
2168
2206
|
# sessions cannot be updated.
|
2169
2207
|
#
|
2170
|
-
#
|
2208
|
+
# The maximum number of players per game session is 200. It is not
|
2209
|
+
# adjustable.
|
2210
|
+
#
|
2211
|
+
# *Available in Amazon Web Services Local.*
|
2171
2212
|
#
|
2172
2213
|
# **Related actions**
|
2173
2214
|
#
|
@@ -2242,7 +2283,10 @@ module Aws::GameLift
|
|
2242
2283
|
# to validate the player reservation with the GameLift service. Player
|
2243
2284
|
# sessions cannot be updated.
|
2244
2285
|
#
|
2245
|
-
#
|
2286
|
+
# The maximum number of players per game session is 200. It is not
|
2287
|
+
# adjustable.
|
2288
|
+
#
|
2289
|
+
# *Available in Amazon Web Services Local.*
|
2246
2290
|
#
|
2247
2291
|
# **Related actions**
|
2248
2292
|
#
|
@@ -2262,10 +2306,10 @@ module Aws::GameLift
|
|
2262
2306
|
#
|
2263
2307
|
# @option params [Hash<String,String>] :player_data_map
|
2264
2308
|
# Map of string pairs, each specifying a player ID and a set of
|
2265
|
-
# developer-defined information related to the player. Amazon
|
2266
|
-
# does not use this data, so it can be formatted as needed for
|
2267
|
-
# the game. Any player data strings for player IDs that are not
|
2268
|
-
# in the `PlayerIds` parameter are ignored.
|
2309
|
+
# developer-defined information related to the player. Amazon Web
|
2310
|
+
# Services does not use this data, so it can be formatted as needed for
|
2311
|
+
# use in the game. Any player data strings for player IDs that are not
|
2312
|
+
# included in the `PlayerIds` parameter are ignored.
|
2269
2313
|
#
|
2270
2314
|
# @return [Types::CreatePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2271
2315
|
#
|
@@ -2320,23 +2364,24 @@ module Aws::GameLift
|
|
2320
2364
|
# * A locally available directory. Use the *ZipFile* parameter for this
|
2321
2365
|
# option.
|
2322
2366
|
#
|
2323
|
-
# * An Amazon Simple Storage Service (Amazon S3) bucket under your
|
2324
|
-
# account. Use the *StorageLocation* parameter for
|
2325
|
-
# You'll need to have an Identity Access Management
|
2326
|
-
# allows the Amazon
|
2367
|
+
# * An Amazon Simple Storage Service (Amazon S3) bucket under your
|
2368
|
+
# Amazon Web Services account. Use the *StorageLocation* parameter for
|
2369
|
+
# this option. You'll need to have an Identity Access Management
|
2370
|
+
# (IAM) role that allows the Amazon Web Services service to access
|
2371
|
+
# your S3 bucket.
|
2327
2372
|
#
|
2328
2373
|
# If the call is successful, a new script record is created with a
|
2329
2374
|
# unique script ID. If the script file is provided as a local file, the
|
2330
|
-
# file is uploaded to an Amazon
|
2331
|
-
# record's storage location reflects this location. If the
|
2332
|
-
# is provided as an S3 bucket, Amazon
|
2333
|
-
# storage location as needed for deployment.
|
2375
|
+
# file is uploaded to an Amazon Web Services-owned S3 bucket and the
|
2376
|
+
# script record's storage location reflects this location. If the
|
2377
|
+
# script file is provided as an S3 bucket, Amazon Web Services accesses
|
2378
|
+
# the file at this storage location as needed for deployment.
|
2334
2379
|
#
|
2335
2380
|
# **Learn more**
|
2336
2381
|
#
|
2337
|
-
# [Amazon
|
2382
|
+
# [Amazon Web Services Realtime Servers][1]
|
2338
2383
|
#
|
2339
|
-
# [Set Up a Role for Amazon
|
2384
|
+
# [Set Up a Role for Amazon Web Services Access][2]
|
2340
2385
|
#
|
2341
2386
|
# **Related actions**
|
2342
2387
|
#
|
@@ -2363,30 +2408,32 @@ module Aws::GameLift
|
|
2363
2408
|
# The location of the Amazon S3 bucket where a zipped file containing
|
2364
2409
|
# your Realtime scripts is stored. The storage location must specify the
|
2365
2410
|
# Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
|
2366
|
-
# that allows Amazon
|
2367
|
-
# The S3 bucket must be in the same Region where you want to
|
2368
|
-
# new script. By default, Amazon
|
2369
|
-
# the zip file; if you have S3 object versioning
|
2370
|
-
# the `ObjectVersion` parameter to specify an
|
2411
|
+
# that allows Amazon Web Services to access the Amazon S3 storage
|
2412
|
+
# location. The S3 bucket must be in the same Region where you want to
|
2413
|
+
# create a new script. By default, Amazon Web Services uploads the
|
2414
|
+
# latest version of the zip file; if you have S3 object versioning
|
2415
|
+
# turned on, you can use the `ObjectVersion` parameter to specify an
|
2416
|
+
# earlier version.
|
2371
2417
|
#
|
2372
2418
|
# @option params [String, StringIO, File] :zip_file
|
2373
2419
|
# A data object containing your Realtime scripts and dependencies as a
|
2374
2420
|
# zip file. The zip file can have one or multiple files. Maximum size of
|
2375
2421
|
# a zip file is 5 MB.
|
2376
2422
|
#
|
2377
|
-
# When using the
|
2378
|
-
# to the zip file name. It must be prepended with the
|
2379
|
-
# "fileb://" to indicate that the file data is a binary object.
|
2380
|
-
# example: `--zip-file fileb://myRealtimeScript.zip`.
|
2423
|
+
# When using the Amazon Web Services CLI tool to create a script, this
|
2424
|
+
# parameter is set to the zip file name. It must be prepended with the
|
2425
|
+
# string "fileb://" to indicate that the file data is a binary object.
|
2426
|
+
# For example: `--zip-file fileb://myRealtimeScript.zip`.
|
2381
2427
|
#
|
2382
2428
|
# @option params [Array<Types::Tag>] :tags
|
2383
2429
|
# A list of labels to assign to the new script resource. Tags are
|
2384
|
-
# developer-defined key-value pairs. Tagging
|
2385
|
-
# for resource management, access management and
|
2386
|
-
# more information, see [ Tagging
|
2387
|
-
#
|
2388
|
-
#
|
2389
|
-
#
|
2430
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
2431
|
+
# resources are useful for resource management, access management and
|
2432
|
+
# cost allocation. For more information, see [ Tagging Amazon Web
|
2433
|
+
# Services Resources][1] in the *Amazon Web Services General Reference*.
|
2434
|
+
# Once the resource is created, you can use TagResource, UntagResource,
|
2435
|
+
# and ListTagsForResource to add, remove, and view tags. The maximum tag
|
2436
|
+
# limit may be lower than stated. See the Amazon Web Services General
|
2390
2437
|
# Reference for actual tagging limits.
|
2391
2438
|
#
|
2392
2439
|
#
|
@@ -2440,32 +2487,35 @@ module Aws::GameLift
|
|
2440
2487
|
end
|
2441
2488
|
|
2442
2489
|
# Requests authorization to create or delete a peer connection between
|
2443
|
-
# the VPC for your Amazon
|
2444
|
-
# (VPC) in your
|
2445
|
-
# your fleet to communicate directly with other
|
2446
|
-
# you've received authorization, call
|
2447
|
-
# establish the peering connection. For
|
2448
|
-
# Peering with Amazon
|
2449
|
-
#
|
2450
|
-
#
|
2451
|
-
#
|
2452
|
-
#
|
2453
|
-
#
|
2490
|
+
# the VPC for your Amazon Web Services fleet and a virtual private cloud
|
2491
|
+
# (VPC) in your Amazon Web Services account. VPC peering enables the
|
2492
|
+
# game servers on your fleet to communicate directly with other Amazon
|
2493
|
+
# Web Services resources. Once you've received authorization, call
|
2494
|
+
# CreateVpcPeeringConnection to establish the peering connection. For
|
2495
|
+
# more information, see [VPC Peering with Amazon Web Services
|
2496
|
+
# Fleets][1].
|
2497
|
+
#
|
2498
|
+
# You can peer with VPCs that are owned by any Amazon Web Services
|
2499
|
+
# account you have access to, including the account that you use to
|
2500
|
+
# manage your Amazon Web Services fleets. You cannot peer with VPCs that
|
2501
|
+
# are in different Regions.
|
2454
2502
|
#
|
2455
2503
|
# To request authorization to create a connection, call this operation
|
2456
|
-
# from the
|
2457
|
-
#
|
2458
|
-
# data from a DynamoDB table, use the account
|
2459
|
-
# resource. Identify the following values:
|
2460
|
-
# you want to peer with, and (2) the ID of
|
2461
|
-
#
|
2462
|
-
# for the specified
|
2504
|
+
# from the Amazon Web Services account with the VPC that you want to
|
2505
|
+
# peer to your Amazon Web Services fleet. For example, to enable your
|
2506
|
+
# game servers to retrieve data from a DynamoDB table, use the account
|
2507
|
+
# that manages that DynamoDB resource. Identify the following values:
|
2508
|
+
# (1) The ID of the VPC that you want to peer with, and (2) the ID of
|
2509
|
+
# the Amazon Web Services account that you use to manage Amazon Web
|
2510
|
+
# Services. If successful, VPC peering is authorized for the specified
|
2511
|
+
# VPC.
|
2463
2512
|
#
|
2464
2513
|
# To request authorization to delete a connection, call this operation
|
2465
|
-
# from the
|
2466
|
-
#
|
2467
|
-
# want to delete the peering connection for, and (2) ID of
|
2468
|
-
# account that you use to manage Amazon
|
2514
|
+
# from the Amazon Web Services account with the VPC that is peered with
|
2515
|
+
# your Amazon Web Services fleet. Identify the following values: (1) VPC
|
2516
|
+
# ID that you want to delete the peering connection for, and (2) ID of
|
2517
|
+
# the Amazon Web Services account that you use to manage Amazon Web
|
2518
|
+
# Services.
|
2469
2519
|
#
|
2470
2520
|
# The authorization remains valid for 24 hours unless it is canceled by
|
2471
2521
|
# a call to DeleteVpcPeeringAuthorization. You must create or delete the
|
@@ -2484,16 +2534,16 @@ module Aws::GameLift
|
|
2484
2534
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2485
2535
|
#
|
2486
2536
|
# @option params [required, String] :game_lift_aws_account_id
|
2487
|
-
# A unique identifier for the
|
2488
|
-
# GameLift fleet. You can find your Account ID in the
|
2489
|
-
# Console under account settings.
|
2537
|
+
# A unique identifier for the Amazon Web Services account that you use
|
2538
|
+
# to manage your GameLift fleet. You can find your Account ID in the
|
2539
|
+
# Amazon Web Services Management Console under account settings.
|
2490
2540
|
#
|
2491
2541
|
# @option params [required, String] :peer_vpc_id
|
2492
2542
|
# A unique identifier for a VPC with resources to be accessed by your
|
2493
2543
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
2494
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
2495
|
-
# Console. Learn more about VPC peering in [VPC
|
2496
|
-
# Fleets][2].
|
2544
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
2545
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
2546
|
+
# Peering with GameLift Fleets][2].
|
2497
2547
|
#
|
2498
2548
|
#
|
2499
2549
|
#
|
@@ -2529,13 +2579,14 @@ module Aws::GameLift
|
|
2529
2579
|
end
|
2530
2580
|
|
2531
2581
|
# Establishes a VPC peering connection between a virtual private cloud
|
2532
|
-
# (VPC) in an
|
2533
|
-
# VPC peering enables the game servers on your fleet
|
2534
|
-
# directly with other
|
2535
|
-
#
|
2536
|
-
#
|
2537
|
-
#
|
2538
|
-
#
|
2582
|
+
# (VPC) in an Amazon Web Services account with the VPC for your Amazon
|
2583
|
+
# Web Services fleet. VPC peering enables the game servers on your fleet
|
2584
|
+
# to communicate directly with other Amazon Web Services resources. You
|
2585
|
+
# can peer with VPCs in any Amazon Web Services account that you have
|
2586
|
+
# access to, including the account that you use to manage your Amazon
|
2587
|
+
# Web Services fleets. You cannot peer with VPCs that are in different
|
2588
|
+
# Regions. For more information, see [VPC Peering with Amazon Web
|
2589
|
+
# Services Fleets][1].
|
2539
2590
|
#
|
2540
2591
|
# Before calling this operation to establish the peering connection, you
|
2541
2592
|
# first need to call CreateVpcPeeringAuthorization and identify the VPC
|
@@ -2544,16 +2595,16 @@ module Aws::GameLift
|
|
2544
2595
|
# operations handle all tasks necessary to peer the two VPCs, including
|
2545
2596
|
# acceptance, updating routing tables, etc.
|
2546
2597
|
#
|
2547
|
-
# To establish the connection, call this operation from the
|
2548
|
-
# that is used to manage the Amazon
|
2549
|
-
# following values: (1) The ID of the fleet you
|
2550
|
-
# peering connection for; (2) The
|
2551
|
-
#
|
2552
|
-
#
|
2553
|
-
# request is created. You can use
|
2554
|
-
# request's status using
|
2555
|
-
# monitoring fleet events for
|
2556
|
-
# DescribeFleetEvents.
|
2598
|
+
# To establish the connection, call this operation from the Amazon Web
|
2599
|
+
# Services account that is used to manage the Amazon Web Services
|
2600
|
+
# fleets. Identify the following values: (1) The ID of the fleet you
|
2601
|
+
# want to be enable a VPC peering connection for; (2) The Amazon Web
|
2602
|
+
# Services account with the VPC that you want to peer with; and (3) The
|
2603
|
+
# ID of the VPC you want to peer with. This operation is asynchronous.
|
2604
|
+
# If successful, a VpcPeeringConnection request is created. You can use
|
2605
|
+
# continuous polling to track the request's status using
|
2606
|
+
# DescribeVpcPeeringConnections, or by monitoring fleet events for
|
2607
|
+
# success or failure using DescribeFleetEvents.
|
2557
2608
|
#
|
2558
2609
|
# **Related actions**
|
2559
2610
|
#
|
@@ -2569,19 +2620,21 @@ module Aws::GameLift
|
|
2569
2620
|
#
|
2570
2621
|
# @option params [required, String] :fleet_id
|
2571
2622
|
# A unique identifier for the fleet. You can use either the fleet ID or
|
2572
|
-
# ARN value. This tells Amazon
|
2623
|
+
# ARN value. This tells Amazon Web Services which GameLift VPC to peer
|
2624
|
+
# with.
|
2573
2625
|
#
|
2574
2626
|
# @option params [required, String] :peer_vpc_aws_account_id
|
2575
|
-
# A unique identifier for the
|
2576
|
-
# peer your Amazon
|
2577
|
-
# the
|
2627
|
+
# A unique identifier for the Amazon Web Services account with the VPC
|
2628
|
+
# that you want to peer your Amazon Web Services fleet with. You can
|
2629
|
+
# find your Account ID in the Amazon Web Services Management Console
|
2630
|
+
# under account settings.
|
2578
2631
|
#
|
2579
2632
|
# @option params [required, String] :peer_vpc_id
|
2580
2633
|
# A unique identifier for a VPC with resources to be accessed by your
|
2581
2634
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
2582
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
2583
|
-
# Console. Learn more about VPC peering in [VPC
|
2584
|
-
# Fleets][2].
|
2635
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
2636
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
2637
|
+
# Peering with GameLift Fleets][2].
|
2585
2638
|
#
|
2586
2639
|
#
|
2587
2640
|
#
|
@@ -2774,7 +2827,7 @@ module Aws::GameLift
|
|
2774
2827
|
#
|
2775
2828
|
# @option params [required, Array<String>] :locations
|
2776
2829
|
# The list of fleet locations to delete. Specify locations in the form
|
2777
|
-
# of an
|
2830
|
+
# of an Amazon Web Services Region code, such as `us-west-2`.
|
2778
2831
|
#
|
2779
2832
|
# @return [Types::DeleteFleetLocationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2780
2833
|
#
|
@@ -2860,16 +2913,16 @@ module Aws::GameLift
|
|
2860
2913
|
# @option params [String] :delete_option
|
2861
2914
|
# The type of delete to perform. Options include the following:
|
2862
2915
|
#
|
2863
|
-
# * `SAFE_DELETE` – (default) Terminates the game server group and
|
2864
|
-
# Auto Scaling group only when it has no game servers that
|
2865
|
-
# `UTILIZED` status.
|
2916
|
+
# * `SAFE_DELETE` – (default) Terminates the game server group and
|
2917
|
+
# Amazon EC2 Auto Scaling group only when it has no game servers that
|
2918
|
+
# are in `UTILIZED` status.
|
2866
2919
|
#
|
2867
2920
|
# * `FORCE_DELETE` – Terminates the game server group, including all
|
2868
2921
|
# active game servers regardless of their utilization status, and the
|
2869
|
-
# EC2 Auto Scaling group.
|
2922
|
+
# Amazon EC2 Auto Scaling group.
|
2870
2923
|
#
|
2871
2924
|
# * `RETAIN` – Does a safe delete of the game server group but retains
|
2872
|
-
# the EC2 Auto Scaling group as is.
|
2925
|
+
# the Amazon EC2 Auto Scaling group as is.
|
2873
2926
|
#
|
2874
2927
|
# @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2875
2928
|
#
|
@@ -2910,23 +2963,28 @@ module Aws::GameLift
|
|
2910
2963
|
end
|
2911
2964
|
|
2912
2965
|
# Deletes a game session queue. Once a queue is successfully deleted,
|
2913
|
-
# unfulfilled StartGameSessionPlacement requests that reference the
|
2966
|
+
# unfulfilled [StartGameSessionPlacement][1] requests that reference the
|
2914
2967
|
# queue will fail. To delete a queue, specify the queue name.
|
2915
2968
|
#
|
2916
2969
|
# **Learn more**
|
2917
2970
|
#
|
2918
|
-
# [ Using Multi-Region Queues][
|
2971
|
+
# [ Using Multi-Region Queues][2]
|
2919
2972
|
#
|
2920
2973
|
# **Related actions**
|
2921
2974
|
#
|
2922
|
-
# CreateGameSessionQueue \| DescribeGameSessionQueues \|
|
2923
|
-
# UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All
|
2924
|
-
# task][
|
2975
|
+
# [CreateGameSessionQueue][3] \| [DescribeGameSessionQueues][4] \|
|
2976
|
+
# [UpdateGameSessionQueue][5] \| [DeleteGameSessionQueue][6] \| [All
|
2977
|
+
# APIs by task][7]
|
2925
2978
|
#
|
2926
2979
|
#
|
2927
2980
|
#
|
2928
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2929
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/
|
2981
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html
|
2982
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
2983
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
2984
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
2985
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
2986
|
+
# [6]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
2987
|
+
# [7]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
2930
2988
|
#
|
2931
2989
|
# @option params [required, String] :name
|
2932
2990
|
# A descriptive label that is associated with game session queue. Queue
|
@@ -3089,7 +3147,7 @@ module Aws::GameLift
|
|
3089
3147
|
#
|
3090
3148
|
# **Learn more**
|
3091
3149
|
#
|
3092
|
-
# [Amazon
|
3150
|
+
# [Amazon Web Services Realtime Servers][1]
|
3093
3151
|
#
|
3094
3152
|
# **Related actions**
|
3095
3153
|
#
|
@@ -3138,16 +3196,16 @@ module Aws::GameLift
|
|
3138
3196
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3139
3197
|
#
|
3140
3198
|
# @option params [required, String] :game_lift_aws_account_id
|
3141
|
-
# A unique identifier for the
|
3142
|
-
# GameLift fleet. You can find your Account ID in the
|
3143
|
-
# Console under account settings.
|
3199
|
+
# A unique identifier for the Amazon Web Services account that you use
|
3200
|
+
# to manage your GameLift fleet. You can find your Account ID in the
|
3201
|
+
# Amazon Web Services Management Console under account settings.
|
3144
3202
|
#
|
3145
3203
|
# @option params [required, String] :peer_vpc_id
|
3146
3204
|
# A unique identifier for a VPC with resources to be accessed by your
|
3147
3205
|
# GameLift fleet. The VPC must be in the same Region as your fleet. To
|
3148
|
-
# look up a VPC ID, use the [VPC Dashboard][1] in the
|
3149
|
-
# Console. Learn more about VPC peering in [VPC
|
3150
|
-
# Fleets][2].
|
3206
|
+
# look up a VPC ID, use the [VPC Dashboard][1] in the Amazon Web
|
3207
|
+
# Services Management Console. Learn more about VPC peering in [VPC
|
3208
|
+
# Peering with GameLift Fleets][2].
|
3151
3209
|
#
|
3152
3210
|
#
|
3153
3211
|
#
|
@@ -3178,10 +3236,10 @@ module Aws::GameLift
|
|
3178
3236
|
# DescribeVpcPeeringAuthorizations or request a new one using
|
3179
3237
|
# CreateVpcPeeringAuthorization.
|
3180
3238
|
#
|
3181
|
-
# Once a valid authorization exists, call this operation from the
|
3182
|
-
# account that is used to manage the Amazon
|
3183
|
-
# the connection to delete by the connection ID and
|
3184
|
-
# successful, the connection is removed.
|
3239
|
+
# Once a valid authorization exists, call this operation from the Amazon
|
3240
|
+
# Web Services account that is used to manage the Amazon Web Services
|
3241
|
+
# fleets. Identify the connection to delete by the connection ID and
|
3242
|
+
# fleet ID. If successful, the connection is removed.
|
3185
3243
|
#
|
3186
3244
|
# **Related actions**
|
3187
3245
|
#
|
@@ -3377,22 +3435,23 @@ module Aws::GameLift
|
|
3377
3435
|
req.send_request(options)
|
3378
3436
|
end
|
3379
3437
|
|
3380
|
-
# The GameLift service limits and current utilization for an
|
3381
|
-
# or location. Instance limits control the number of
|
3382
|
-
# instance type, per location, that your
|
3383
|
-
# at [Amazon EC2 Instance
|
3384
|
-
#
|
3385
|
-
#
|
3386
|
-
#
|
3387
|
-
#
|
3438
|
+
# The GameLift service limits and current utilization for an Amazon Web
|
3439
|
+
# Services Region or location. Instance limits control the number of
|
3440
|
+
# instances, per instance type, per location, that your Amazon Web
|
3441
|
+
# Services account can use. Learn more at [Amazon EC2 Instance
|
3442
|
+
# Types][1]. The information returned includes the maximum number of
|
3443
|
+
# instances allowed and your account's current usage across all fleets.
|
3444
|
+
# This information can affect your ability to scale your GameLift
|
3445
|
+
# fleets. You can request a limit increase for your account by using the
|
3446
|
+
# **Service limits** page in the GameLift console.
|
3388
3447
|
#
|
3389
3448
|
# Instance limits differ based on whether the instances are deployed in
|
3390
3449
|
# a fleet's home Region or in a remote location. For remote locations,
|
3391
3450
|
# limits also differ based on the combination of home Region and remote
|
3392
|
-
# location. All requests must specify an
|
3393
|
-
# or as your default settings). To get the limit for
|
3394
|
-
# you must also specify the location. For example,
|
3395
|
-
# requests all return different results:
|
3451
|
+
# location. All requests must specify an Amazon Web Services Region
|
3452
|
+
# (either explicitly or as your default settings). To get the limit for
|
3453
|
+
# a remote location, you must also specify the location. For example,
|
3454
|
+
# the following requests all return different results:
|
3396
3455
|
#
|
3397
3456
|
# * Request specifies the Region `ap-northeast-1` with no location. The
|
3398
3457
|
# result is limits and usage data on all instance types that are
|
@@ -3413,14 +3472,15 @@ module Aws::GameLift
|
|
3413
3472
|
# This operation can be used in the following ways:
|
3414
3473
|
#
|
3415
3474
|
# * To get limit and usage data for all instance types that are deployed
|
3416
|
-
# in an
|
3417
|
-
# the Region only. Optionally, specify a single
|
3418
|
-
# retrieve information for.
|
3475
|
+
# in an Amazon Web Services Region by fleets that reside in the same
|
3476
|
+
# Region: Specify the Region only. Optionally, specify a single
|
3477
|
+
# instance type to retrieve information for.
|
3419
3478
|
#
|
3420
3479
|
# * To get limit and usage data for all instance types that are deployed
|
3421
|
-
# to a remote location by fleets that reside in different
|
3422
|
-
# Provide both the
|
3423
|
-
# specify a single instance type to
|
3480
|
+
# to a remote location by fleets that reside in different Amazon Web
|
3481
|
+
# Services Region: Provide both the Amazon Web Services Region and the
|
3482
|
+
# remote location. Optionally, specify a single instance type to
|
3483
|
+
# retrieve information for.
|
3424
3484
|
#
|
3425
3485
|
# If successful, an `EC2InstanceLimits` object is returned with limits
|
3426
3486
|
# and usage data for each requested instance type.
|
@@ -3443,15 +3503,15 @@ module Aws::GameLift
|
|
3443
3503
|
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
3444
3504
|
#
|
3445
3505
|
# @option params [String] :ec2_instance_type
|
3446
|
-
# Name of an EC2 instance type that is supported in GameLift. A
|
3447
|
-
# instance type determines the computing resources of each
|
3448
|
-
# the fleet, including CPU, memory, storage, and networking
|
3449
|
-
# not specify a value for this parameter to retrieve limits
|
3450
|
-
# instance types.
|
3506
|
+
# Name of an Amazon EC2 instance type that is supported in GameLift. A
|
3507
|
+
# fleet instance type determines the computing resources of each
|
3508
|
+
# instance in the fleet, including CPU, memory, storage, and networking
|
3509
|
+
# capacity. Do not specify a value for this parameter to retrieve limits
|
3510
|
+
# for all instance types.
|
3451
3511
|
#
|
3452
3512
|
# @option params [String] :location
|
3453
3513
|
# The name of a remote location to request instance limits for, in the
|
3454
|
-
# form of an
|
3514
|
+
# form of an Amazon Web Services Region code such as `us-west-2`.
|
3455
3515
|
#
|
3456
3516
|
# @return [Types::DescribeEC2InstanceLimitsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3457
3517
|
#
|
@@ -3839,7 +3899,8 @@ module Aws::GameLift
|
|
3839
3899
|
#
|
3840
3900
|
# @option params [Array<String>] :locations
|
3841
3901
|
# A list of fleet locations to retrieve information for. Specify
|
3842
|
-
# locations in the form of an
|
3902
|
+
# locations in the form of an Amazon Web Services Region code, such as
|
3903
|
+
# `us-west-2`.
|
3843
3904
|
#
|
3844
3905
|
# @option params [Integer] :limit
|
3845
3906
|
# The maximum number of results to return. Use this parameter with
|
@@ -3929,7 +3990,8 @@ module Aws::GameLift
|
|
3929
3990
|
#
|
3930
3991
|
# @option params [required, String] :location
|
3931
3992
|
# The fleet location to retrieve capacity information for. Specify a
|
3932
|
-
# location in the form of an
|
3993
|
+
# location in the form of an Amazon Web Services Region code, such as
|
3994
|
+
# `us-west-2`.
|
3933
3995
|
#
|
3934
3996
|
# @return [Types::DescribeFleetLocationCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3935
3997
|
#
|
@@ -4002,7 +4064,8 @@ module Aws::GameLift
|
|
4002
4064
|
#
|
4003
4065
|
# @option params [required, String] :location
|
4004
4066
|
# The fleet location to retrieve utilization information for. Specify a
|
4005
|
-
# location in the form of an
|
4067
|
+
# location in the form of an Amazon Web Services Region code, such as
|
4068
|
+
# `us-west-2`.
|
4006
4069
|
#
|
4007
4070
|
# @return [Types::DescribeFleetLocationUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4008
4071
|
#
|
@@ -4077,7 +4140,7 @@ module Aws::GameLift
|
|
4077
4140
|
#
|
4078
4141
|
# @option params [String] :location
|
4079
4142
|
# A remote location to check for status of port setting updates. Use the
|
4080
|
-
#
|
4143
|
+
# Amazon Web Services Region code format, such as `us-west-2`.
|
4081
4144
|
#
|
4082
4145
|
# @return [Types::DescribeFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4083
4146
|
#
|
@@ -4398,10 +4461,10 @@ module Aws::GameLift
|
|
4398
4461
|
# GameServerGroup name or ARN value.
|
4399
4462
|
#
|
4400
4463
|
# @option params [Array<String>] :instance_ids
|
4401
|
-
# The EC2 instance IDs that you want to retrieve status on.
|
4402
|
-
# IDs use a 17-character format, for example:
|
4403
|
-
# retrieve all instances in the game server
|
4404
|
-
# empty.
|
4464
|
+
# The Amazon EC2 instance IDs that you want to retrieve status on.
|
4465
|
+
# Amazon EC2 instance IDs use a 17-character format, for example:
|
4466
|
+
# `i-1234567890abcdef0`. To retrieve all instances in the game server
|
4467
|
+
# group, leave this parameter empty.
|
4405
4468
|
#
|
4406
4469
|
# @option params [Integer] :limit
|
4407
4470
|
# The maximum number of results to return. Use this parameter with
|
@@ -4469,7 +4532,8 @@ module Aws::GameLift
|
|
4469
4532
|
#
|
4470
4533
|
# * To retrieve details for a specific game session, provide the game
|
4471
4534
|
# session ID. This approach looks for the game session ID in all
|
4472
|
-
# fleets that reside in the
|
4535
|
+
# fleets that reside in the Amazon Web Services Region defined in the
|
4536
|
+
# request.
|
4473
4537
|
#
|
4474
4538
|
# Use the pagination parameters to retrieve results as a set of
|
4475
4539
|
# sequential pages.
|
@@ -4508,8 +4572,8 @@ module Aws::GameLift
|
|
4508
4572
|
#
|
4509
4573
|
# @option params [String] :location
|
4510
4574
|
# A fleet location to get game sessions for. You can specify a fleet's
|
4511
|
-
# home Region or a remote location. Use the
|
4512
|
-
# as `us-west-2`.
|
4575
|
+
# home Region or a remote location. Use the Amazon Web Services Region
|
4576
|
+
# code format, such as `us-west-2`.
|
4513
4577
|
#
|
4514
4578
|
# @option params [String] :status_filter
|
4515
4579
|
# Game session status to filter results on. Possible game session
|
@@ -4586,6 +4650,14 @@ module Aws::GameLift
|
|
4586
4650
|
#
|
4587
4651
|
# To get game session placement details, specify the placement ID.
|
4588
4652
|
#
|
4653
|
+
# This operation is not designed to be continually called to track game
|
4654
|
+
# session status. This practice can cause you to exceed your API limit,
|
4655
|
+
# which results in errors. Instead, you must configure configure an
|
4656
|
+
# Amazon Simple Notification Service (SNS) topic to receive
|
4657
|
+
# notifications from FlexMatch or queues. Continuously polling with
|
4658
|
+
# `DescribeGameSessionPlacement` should only be used for games in
|
4659
|
+
# development with low game session usage.
|
4660
|
+
#
|
4589
4661
|
# If successful, a GameSessionPlacement object is returned.
|
4590
4662
|
#
|
4591
4663
|
# **Related actions**
|
@@ -4663,14 +4735,18 @@ module Aws::GameLift
|
|
4663
4735
|
#
|
4664
4736
|
# **Related actions**
|
4665
4737
|
#
|
4666
|
-
# CreateGameSessionQueue \| DescribeGameSessionQueues \|
|
4667
|
-
# UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All
|
4668
|
-
# task][
|
4738
|
+
# [CreateGameSessionQueue][2] \| [DescribeGameSessionQueues][3] \|
|
4739
|
+
# [UpdateGameSessionQueue][4] \| [DeleteGameSessionQueue][5] \| [All
|
4740
|
+
# APIs by task][6]
|
4669
4741
|
#
|
4670
4742
|
#
|
4671
4743
|
#
|
4672
4744
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html
|
4673
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
4745
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
4746
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
4747
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
4748
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
4749
|
+
# [6]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
4674
4750
|
#
|
4675
4751
|
# @option params [Array<String>] :names
|
4676
4752
|
# A list of queue names to retrieve information for. You can use either
|
@@ -4740,6 +4816,14 @@ module Aws::GameLift
|
|
4740
4816
|
# retrieve the protection policy for game sessions, use
|
4741
4817
|
# DescribeGameSessionDetails.
|
4742
4818
|
#
|
4819
|
+
# This operation is not designed to be continually called to track game
|
4820
|
+
# session status. This practice can cause you to exceed your API limit,
|
4821
|
+
# which results in errors. Instead, you must configure configure an
|
4822
|
+
# Amazon Simple Notification Service (SNS) topic to receive
|
4823
|
+
# notifications from FlexMatch or queues. Continuously polling with
|
4824
|
+
# `DescribeGameSessions` should only be used for games in development
|
4825
|
+
# with low game session usage.
|
4826
|
+
#
|
4743
4827
|
# This operation can be used in the following ways:
|
4744
4828
|
#
|
4745
4829
|
# * To retrieve all game sessions that are currently running on all
|
@@ -4754,7 +4838,7 @@ module Aws::GameLift
|
|
4754
4838
|
#
|
4755
4839
|
# * To retrieve a specific game session, provide the game session ID.
|
4756
4840
|
# This approach looks for the game session ID in all fleets that
|
4757
|
-
# reside in the
|
4841
|
+
# reside in the Amazon Web Services Region defined in the request.
|
4758
4842
|
#
|
4759
4843
|
# Use the pagination parameters to retrieve results as a set of
|
4760
4844
|
# sequential pages.
|
@@ -4762,7 +4846,15 @@ module Aws::GameLift
|
|
4762
4846
|
# If successful, a `GameSession` object is returned for each game
|
4763
4847
|
# session that matches the request.
|
4764
4848
|
#
|
4765
|
-
#
|
4849
|
+
# This operation is not designed to be continually called to track
|
4850
|
+
# matchmaking ticket status. This practice can cause you to exceed your
|
4851
|
+
# API limit, which results in errors. Instead, as a best practice, set
|
4852
|
+
# up an Amazon Simple Notification Service to receive notifications, and
|
4853
|
+
# provide the topic ARN in the matchmaking configuration. Continuously
|
4854
|
+
# poling ticket status with DescribeGameSessions should only be used for
|
4855
|
+
# games in development with low matchmaking usage.
|
4856
|
+
#
|
4857
|
+
# *Available in Amazon Web Services Local.*
|
4766
4858
|
#
|
4767
4859
|
# **Learn more**
|
4768
4860
|
#
|
@@ -4795,8 +4887,8 @@ module Aws::GameLift
|
|
4795
4887
|
#
|
4796
4888
|
# @option params [String] :location
|
4797
4889
|
# A fleet location to get game session details for. You can specify a
|
4798
|
-
# fleet's home Region or a remote location. Use the
|
4799
|
-
# format, such as `us-west-2`.
|
4890
|
+
# fleet's home Region or a remote location. Use the Amazon Web Services
|
4891
|
+
# Region code format, such as `us-west-2`.
|
4800
4892
|
#
|
4801
4893
|
# @option params [String] :status_filter
|
4802
4894
|
# Game session status to filter results on. You can filter on the
|
@@ -4925,7 +5017,7 @@ module Aws::GameLift
|
|
4925
5017
|
#
|
4926
5018
|
# @option params [String] :location
|
4927
5019
|
# The name of a location to retrieve instance information for, in the
|
4928
|
-
# form of an
|
5020
|
+
# form of an Amazon Web Services Region code such as `us-west-2`.
|
4929
5021
|
#
|
4930
5022
|
# @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4931
5023
|
#
|
@@ -4979,11 +5071,10 @@ module Aws::GameLift
|
|
4979
5071
|
# This operation is not designed to be continually called to track
|
4980
5072
|
# matchmaking ticket status. This practice can cause you to exceed your
|
4981
5073
|
# API limit, which results in errors. Instead, as a best practice, set
|
4982
|
-
# up an Amazon Simple Notification Service
|
4983
|
-
#
|
4984
|
-
#
|
4985
|
-
#
|
4986
|
-
# low matchmaking usage.
|
5074
|
+
# up an Amazon Simple Notification Service to receive notifications, and
|
5075
|
+
# provide the topic ARN in the matchmaking configuration. Continuously
|
5076
|
+
# poling ticket status with DescribeMatchmaking should only be used for
|
5077
|
+
# games in development with low matchmaking usage.
|
4987
5078
|
#
|
4988
5079
|
#
|
4989
5080
|
#
|
@@ -5250,7 +5341,7 @@ module Aws::GameLift
|
|
5250
5341
|
# If successful, a `PlayerSession` object is returned for each session
|
5251
5342
|
# that matches the request.
|
5252
5343
|
#
|
5253
|
-
# *Available in Amazon
|
5344
|
+
# *Available in Amazon Web Services Local.*
|
5254
5345
|
#
|
5255
5346
|
# **Related actions**
|
5256
5347
|
#
|
@@ -5435,8 +5526,8 @@ module Aws::GameLift
|
|
5435
5526
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
5436
5527
|
#
|
5437
5528
|
# @option params [required, String] :fleet_id
|
5438
|
-
# A unique identifier for the fleet to retrieve scaling
|
5439
|
-
# You can use either the fleet ID or ARN value.
|
5529
|
+
# A unique identifier for the fleet for which to retrieve scaling
|
5530
|
+
# policies. You can use either the fleet ID or ARN value.
|
5440
5531
|
#
|
5441
5532
|
# @option params [String] :status_filter
|
5442
5533
|
# Scaling policy status to filter results on. A scaling policy is only
|
@@ -5470,7 +5561,8 @@ module Aws::GameLift
|
|
5470
5561
|
# a value.
|
5471
5562
|
#
|
5472
5563
|
# @option params [String] :location
|
5473
|
-
#
|
5564
|
+
# The fleet location. If you don't specify this value, the response
|
5565
|
+
# contains the scaling policies of every location in the fleet.
|
5474
5566
|
#
|
5475
5567
|
# @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5476
5568
|
#
|
@@ -5524,7 +5616,7 @@ module Aws::GameLift
|
|
5524
5616
|
#
|
5525
5617
|
# **Learn more**
|
5526
5618
|
#
|
5527
|
-
# [Amazon
|
5619
|
+
# [Amazon Web Services Realtime Servers][1]
|
5528
5620
|
#
|
5529
5621
|
# **Related actions**
|
5530
5622
|
#
|
@@ -5573,9 +5665,9 @@ module Aws::GameLift
|
|
5573
5665
|
end
|
5574
5666
|
|
5575
5667
|
# Retrieves valid VPC peering authorizations that are pending for the
|
5576
|
-
#
|
5577
|
-
# requests for peering. This includes those initiated
|
5578
|
-
# this account.
|
5668
|
+
# Amazon Web Services account. This operation returns all VPC peering
|
5669
|
+
# authorizations and requests for peering. This includes those initiated
|
5670
|
+
# and received by this account.
|
5579
5671
|
#
|
5580
5672
|
# **Related actions**
|
5581
5673
|
#
|
@@ -5614,12 +5706,12 @@ module Aws::GameLift
|
|
5614
5706
|
# to get peering information for all fleets or for one specific fleet
|
5615
5707
|
# ID.
|
5616
5708
|
#
|
5617
|
-
# To retrieve connection information, call this operation from the
|
5618
|
-
# account that is used to manage the Amazon
|
5619
|
-
# fleet ID or leave the parameter empty to
|
5620
|
-
# records. If successful, the retrieved
|
5621
|
-
# and pending connections. Active
|
5622
|
-
# block that the VPC uses to connect.
|
5709
|
+
# To retrieve connection information, call this operation from the
|
5710
|
+
# Amazon Web Services account that is used to manage the Amazon Web
|
5711
|
+
# Services fleets. Specify a fleet ID or leave the parameter empty to
|
5712
|
+
# retrieve all connection records. If successful, the retrieved
|
5713
|
+
# information includes both active and pending connections. Active
|
5714
|
+
# connections identify the IpV4 CIDR block that the VPC uses to connect.
|
5623
5715
|
#
|
5624
5716
|
# **Related actions**
|
5625
5717
|
#
|
@@ -5672,8 +5764,8 @@ module Aws::GameLift
|
|
5672
5764
|
# automatically stores the logs in Amazon S3 and retains them for 14
|
5673
5765
|
# days. Use this URL to download the logs.
|
5674
5766
|
#
|
5675
|
-
# <note markdown="1"> See the [
|
5676
|
-
# files that exceed this limit are not saved.
|
5767
|
+
# <note markdown="1"> See the [Amazon Web Services Service Limits][1] page for maximum log
|
5768
|
+
# file sizes. Log files that exceed this limit are not saved.
|
5677
5769
|
#
|
5678
5770
|
# </note>
|
5679
5771
|
#
|
@@ -5726,9 +5818,9 @@ module Aws::GameLift
|
|
5726
5818
|
# Remote Desktop client. For a Linux instance, GameLift returns a user
|
5727
5819
|
# name and RSA private key, also as strings, for use with an SSH client.
|
5728
5820
|
# The private key must be saved in the proper format to a `.pem` file
|
5729
|
-
# before using. If you're making this request using the
|
5730
|
-
#
|
5731
|
-
#
|
5821
|
+
# before using. If you're making this request using the CLI, saving the
|
5822
|
+
# secret can be handled as part of the `GetInstanceAccess` request, as
|
5823
|
+
# shown in one of the examples for this operation.
|
5732
5824
|
#
|
5733
5825
|
# To request access to a specific instance, specify the IDs of both the
|
5734
5826
|
# instance and the fleet it belongs to. You can retrieve a fleet's
|
@@ -5793,9 +5885,9 @@ module Aws::GameLift
|
|
5793
5885
|
req.send_request(options)
|
5794
5886
|
end
|
5795
5887
|
|
5796
|
-
# Retrieves all aliases for this
|
5797
|
-
# set by alias name and/or routing strategy type. Use
|
5798
|
-
# parameters to retrieve results in sequential pages.
|
5888
|
+
# Retrieves all aliases for this Amazon Web Services account. You can
|
5889
|
+
# filter the result set by alias name and/or routing strategy type. Use
|
5890
|
+
# the pagination parameters to retrieve results in sequential pages.
|
5799
5891
|
#
|
5800
5892
|
# <note markdown="1"> Returned aliases are not listed in any particular order.
|
5801
5893
|
#
|
@@ -5878,10 +5970,11 @@ module Aws::GameLift
|
|
5878
5970
|
req.send_request(options)
|
5879
5971
|
end
|
5880
5972
|
|
5881
|
-
# Retrieves build resources for all builds associated with the
|
5882
|
-
# account in use. You can limit results to builds that are
|
5883
|
-
# status by using the `Status` parameter. Use the
|
5884
|
-
# to retrieve results in a set of sequential
|
5973
|
+
# Retrieves build resources for all builds associated with the Amazon
|
5974
|
+
# Web Services account in use. You can limit results to builds that are
|
5975
|
+
# in a specific status by using the `Status` parameter. Use the
|
5976
|
+
# pagination parameters to retrieve results in a set of sequential
|
5977
|
+
# pages.
|
5885
5978
|
#
|
5886
5979
|
# <note markdown="1"> Build resources are not listed in any particular order.
|
5887
5980
|
#
|
@@ -5965,9 +6058,9 @@ module Aws::GameLift
|
|
5965
6058
|
req.send_request(options)
|
5966
6059
|
end
|
5967
6060
|
|
5968
|
-
# Retrieves a collection of fleet resources in an
|
5969
|
-
# call this operation to get fleets in a previously
|
5970
|
-
# Region (see
|
6061
|
+
# Retrieves a collection of fleet resources in an Amazon Web Services
|
6062
|
+
# Region. You can call this operation to get fleets in a previously
|
6063
|
+
# selected default Region (see
|
5971
6064
|
# [https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html][1]or
|
5972
6065
|
# specify a Region in your request. You can filter the result set to
|
5973
6066
|
# find only those fleets that are deployed with a specific build or
|
@@ -6068,8 +6161,9 @@ module Aws::GameLift
|
|
6068
6161
|
# server groups.**
|
6069
6162
|
#
|
6070
6163
|
# Retrieves information on all game servers groups that exist in the
|
6071
|
-
# current
|
6072
|
-
# parameters to retrieve results in a set of sequential
|
6164
|
+
# current Amazon Web Services account for the selected Region. Use the
|
6165
|
+
# pagination parameters to retrieve results in a set of sequential
|
6166
|
+
# segments.
|
6073
6167
|
#
|
6074
6168
|
# **Learn more**
|
6075
6169
|
#
|
@@ -6227,11 +6321,11 @@ module Aws::GameLift
|
|
6227
6321
|
end
|
6228
6322
|
|
6229
6323
|
# Retrieves script records for all Realtime scripts that are associated
|
6230
|
-
# with the
|
6324
|
+
# with the Amazon Web Services account in use.
|
6231
6325
|
#
|
6232
6326
|
# **Learn more**
|
6233
6327
|
#
|
6234
|
-
# [Amazon
|
6328
|
+
# [Amazon Web Services Realtime Servers][1]
|
6235
6329
|
#
|
6236
6330
|
# **Related actions**
|
6237
6331
|
#
|
@@ -6292,9 +6386,9 @@ module Aws::GameLift
|
|
6292
6386
|
end
|
6293
6387
|
|
6294
6388
|
# Retrieves all tags that are assigned to a GameLift resource. Resource
|
6295
|
-
# tags are used to organize
|
6296
|
-
# operation handles the permissions necessary to manage
|
6297
|
-
# following GameLift resource types:
|
6389
|
+
# tags are used to organize Amazon Web Services resources for a range of
|
6390
|
+
# purposes. This operation handles the permissions necessary to manage
|
6391
|
+
# tags for the following GameLift resource types:
|
6298
6392
|
#
|
6299
6393
|
# * Build
|
6300
6394
|
#
|
@@ -6315,9 +6409,10 @@ module Aws::GameLift
|
|
6315
6409
|
#
|
6316
6410
|
# **Learn more**
|
6317
6411
|
#
|
6318
|
-
# [Tagging
|
6412
|
+
# [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
|
6413
|
+
# General Reference*
|
6319
6414
|
#
|
6320
|
-
# [
|
6415
|
+
# [ Amazon Web Services Tagging Strategies][2]
|
6321
6416
|
#
|
6322
6417
|
# **Related actions**
|
6323
6418
|
#
|
@@ -6368,13 +6463,13 @@ module Aws::GameLift
|
|
6368
6463
|
|
6369
6464
|
# Creates or updates a scaling policy for a fleet. Scaling policies are
|
6370
6465
|
# used to automatically scale a fleet's hosting capacity to meet player
|
6371
|
-
# demand. An active scaling policy instructs Amazon
|
6372
|
-
# fleet metric and automatically change the fleet's capacity
|
6373
|
-
# certain threshold is reached. There are two types of scaling
|
6374
|
-
# target-based and rule-based. Use a target-based policy to
|
6375
|
-
# efficiently manage fleet scaling; this option is the most
|
6376
|
-
# used. Use rule-based policies when you need to exert
|
6377
|
-
# control over auto-scaling.
|
6466
|
+
# demand. An active scaling policy instructs Amazon Web Services to
|
6467
|
+
# track a fleet metric and automatically change the fleet's capacity
|
6468
|
+
# when a certain threshold is reached. There are two types of scaling
|
6469
|
+
# policies: target-based and rule-based. Use a target-based policy to
|
6470
|
+
# quickly and efficiently manage fleet scaling; this option is the most
|
6471
|
+
# commonly used. Use rule-based policies when you need to exert
|
6472
|
+
# fine-grained control over auto-scaling.
|
6378
6473
|
#
|
6379
6474
|
# Fleets can have multiple scaling policies of each type in force at the
|
6380
6475
|
# same time; you can have one target-based policy, one or multiple
|
@@ -6399,15 +6494,15 @@ module Aws::GameLift
|
|
6399
6494
|
# currently in use. This is the fleet's buffer; it measures the
|
6400
6495
|
# additional player demand that the fleet could handle at current
|
6401
6496
|
# capacity. With a target-based policy, you set your ideal buffer size
|
6402
|
-
# and leave it to Amazon
|
6403
|
-
# maintain that target.
|
6497
|
+
# and leave it to Amazon Web Services to take whatever action is needed
|
6498
|
+
# to maintain that target.
|
6404
6499
|
#
|
6405
6500
|
# For example, you might choose to maintain a 10% buffer for a fleet
|
6406
6501
|
# that has the capacity to host 100 simultaneous game sessions. This
|
6407
|
-
# policy tells Amazon
|
6502
|
+
# policy tells Amazon Web Services to take action whenever the fleet's
|
6408
6503
|
# available capacity falls below or rises above 10 game sessions. Amazon
|
6409
|
-
#
|
6410
|
-
# return to the 10% buffer.
|
6504
|
+
# Web Services will start new instances or stop unused instances in
|
6505
|
+
# order to return to the 10% buffer.
|
6411
6506
|
#
|
6412
6507
|
# To create or update a target-based policy, specify a fleet ID and
|
6413
6508
|
# name, and set the policy type to "TargetBased". Specify the metric
|
@@ -6503,9 +6598,9 @@ module Aws::GameLift
|
|
6503
6598
|
# threshold before a scaling event is triggered.
|
6504
6599
|
#
|
6505
6600
|
# @option params [required, String] :metric_name
|
6506
|
-
# Name of the Amazon
|
6507
|
-
# scaling adjustment. For detailed descriptions of fleet metrics, see
|
6508
|
-
# [Monitor Amazon
|
6601
|
+
# Name of the Amazon Web Services-defined metric that is used to trigger
|
6602
|
+
# a scaling adjustment. For detailed descriptions of fleet metrics, see
|
6603
|
+
# [Monitor Amazon Web Services with Amazon CloudWatch][1].
|
6509
6604
|
#
|
6510
6605
|
# * **ActivatingGameSessions** -- Game sessions in the process of being
|
6511
6606
|
# created.
|
@@ -6634,7 +6729,7 @@ module Aws::GameLift
|
|
6634
6729
|
# @option params [required, String] :game_server_id
|
6635
6730
|
# A custom string that uniquely identifies the game server to register.
|
6636
6731
|
# Game server IDs are developer-defined and must be unique across all
|
6637
|
-
# game server groups in your
|
6732
|
+
# game server groups in your Amazon Web Services account.
|
6638
6733
|
#
|
6639
6734
|
# @option params [required, String] :instance_id
|
6640
6735
|
# The unique identifier for the instance where the game server is
|
@@ -6690,8 +6785,8 @@ module Aws::GameLift
|
|
6690
6785
|
end
|
6691
6786
|
|
6692
6787
|
# Retrieves a fresh set of credentials for use when uploading a new set
|
6693
|
-
# of game build files to Amazon
|
6694
|
-
# part of the build creation process; see CreateBuild.
|
6788
|
+
# of game build files to Amazon Web Services's Amazon S3. This is done
|
6789
|
+
# as part of the build creation process; see CreateBuild.
|
6695
6790
|
#
|
6696
6791
|
# To request new credentials, specify the build ID as returned with an
|
6697
6792
|
# initial `CreateBuild` request. If successful, a new set of credentials
|
@@ -6867,6 +6962,14 @@ module Aws::GameLift
|
|
6867
6962
|
# Retrieves all active game sessions that match a set of search criteria
|
6868
6963
|
# and sorts them into a specified order.
|
6869
6964
|
#
|
6965
|
+
# This operation is not designed to be continually called to track game
|
6966
|
+
# session status. This practice can cause you to exceed your API limit,
|
6967
|
+
# which results in errors. Instead, you must configure configure an
|
6968
|
+
# Amazon Simple Notification Service (SNS) topic to receive
|
6969
|
+
# notifications from FlexMatch or queues. Continuously polling game
|
6970
|
+
# session status with `DescribeGameSessions` should only be used for
|
6971
|
+
# games in development with low game session usage.
|
6972
|
+
#
|
6870
6973
|
# When searching for game sessions, you specify exactly where you want
|
6871
6974
|
# to search and provide a search filter expression, a sort expression,
|
6872
6975
|
# or both. A search request can search only one fleet, but it can search
|
@@ -6961,8 +7064,8 @@ module Aws::GameLift
|
|
6961
7064
|
#
|
6962
7065
|
# @option params [String] :location
|
6963
7066
|
# A fleet location to search for game sessions. You can specify a
|
6964
|
-
# fleet's home Region or a remote location. Use the
|
6965
|
-
# format, such as `us-west-2`.
|
7067
|
+
# fleet's home Region or a remote location. Use the Amazon Web Services
|
7068
|
+
# Region code format, such as `us-west-2`.
|
6966
7069
|
#
|
6967
7070
|
# @option params [String] :filter_expression
|
6968
7071
|
# String containing the search criteria for the session search. If no
|
@@ -7138,7 +7241,7 @@ module Aws::GameLift
|
|
7138
7241
|
#
|
7139
7242
|
# @option params [String] :location
|
7140
7243
|
# The fleet location to restart fleet actions for. Specify a location in
|
7141
|
-
# the form of an
|
7244
|
+
# the form of an Amazon Web Services Region code, such as `us-west-2`.
|
7142
7245
|
#
|
7143
7246
|
# @return [Types::StartFleetActionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7144
7247
|
#
|
@@ -7169,26 +7272,26 @@ module Aws::GameLift
|
|
7169
7272
|
|
7170
7273
|
# Places a request for a new game session in a queue (see
|
7171
7274
|
# CreateGameSessionQueue). When processing a placement request, Amazon
|
7172
|
-
#
|
7275
|
+
# Web Services searches for available resources on the queue's
|
7173
7276
|
# destinations, scanning each until it finds resources or the placement
|
7174
7277
|
# request times out.
|
7175
7278
|
#
|
7176
7279
|
# A game session placement request can also request player sessions.
|
7177
|
-
# When a new game session is successfully created, Amazon
|
7280
|
+
# When a new game session is successfully created, Amazon Web Services
|
7178
7281
|
# creates a player session for each player included in the request.
|
7179
7282
|
#
|
7180
|
-
# When placing a game session, by default Amazon
|
7283
|
+
# When placing a game session, by default Amazon Web Services tries each
|
7181
7284
|
# fleet in the order they are listed in the queue configuration.
|
7182
7285
|
# Ideally, a queue's destinations are listed in preference order.
|
7183
7286
|
#
|
7184
7287
|
# Alternatively, when requesting a game session with players, you can
|
7185
7288
|
# also provide latency data for each player in relevant Regions. Latency
|
7186
7289
|
# data indicates the performance lag a player experiences when connected
|
7187
|
-
# to a fleet in the Region. Amazon
|
7188
|
-
# the list of destinations to place the game session in a Region
|
7189
|
-
# minimal lag. If latency data is provided for multiple players,
|
7190
|
-
#
|
7191
|
-
# reorders to get the best game play across all players.
|
7290
|
+
# to a fleet in the Region. Amazon Web Services uses latency data to
|
7291
|
+
# reorder the list of destinations to place the game session in a Region
|
7292
|
+
# with minimal lag. If latency data is provided for multiple players,
|
7293
|
+
# Amazon Web Services calculates each Region's average lag for all
|
7294
|
+
# players and reorders to get the best game play across all players.
|
7192
7295
|
#
|
7193
7296
|
# To place a new game session request, specify the following:
|
7194
7297
|
#
|
@@ -7255,7 +7358,7 @@ module Aws::GameLift
|
|
7255
7358
|
#
|
7256
7359
|
# @option params [Array<Types::PlayerLatency>] :player_latencies
|
7257
7360
|
# A set of values, expressed in milliseconds, that indicates the amount
|
7258
|
-
# of latency that a player experiences when connected to
|
7361
|
+
# of latency that a player experiences when connected to @aws; Regions.
|
7259
7362
|
# This information is used to try to place the new game session where it
|
7260
7363
|
# can offer the best possible gameplay experience for the players.
|
7261
7364
|
#
|
@@ -7374,6 +7477,9 @@ module Aws::GameLift
|
|
7374
7477
|
# and returned with status set to QUEUED. Track the status of backfill
|
7375
7478
|
# tickets using the same method for tracking tickets for new matches.
|
7376
7479
|
#
|
7480
|
+
# Only game sessions created by FlexMatch are supported for match
|
7481
|
+
# backfill.
|
7482
|
+
#
|
7377
7483
|
# **Learn more**
|
7378
7484
|
#
|
7379
7485
|
# [ Backfill existing games with FlexMatch][1]
|
@@ -7396,7 +7502,7 @@ module Aws::GameLift
|
|
7396
7502
|
#
|
7397
7503
|
# @option params [String] :ticket_id
|
7398
7504
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
7399
|
-
# specified here, Amazon
|
7505
|
+
# specified here, Amazon Web Services will generate one in the form of a
|
7400
7506
|
# UUID. Use this identifier to track the match backfill ticket status
|
7401
7507
|
# and retrieve match results.
|
7402
7508
|
#
|
@@ -7422,6 +7528,9 @@ module Aws::GameLift
|
|
7422
7528
|
# matchmaker data is in JSON syntax, formatted as a string. For more
|
7423
7529
|
# details, see [ Match Data][1].
|
7424
7530
|
#
|
7531
|
+
# The backfill request must specify the team membership for every
|
7532
|
+
# player. Do not specify team if you are not using backfill.
|
7533
|
+
#
|
7425
7534
|
# * LatencyInMs -- If the matchmaker uses player latency, include a
|
7426
7535
|
# latency value, in milliseconds, for the Region that the game session
|
7427
7536
|
# is currently in. Do not include latency values for any other Region.
|
@@ -7508,7 +7617,7 @@ module Aws::GameLift
|
|
7508
7617
|
# Track matchmaking events to respond as needed and acquire game session
|
7509
7618
|
# connection information for successfully completed matches. Ticket
|
7510
7619
|
# status updates are tracked using event notification through Amazon
|
7511
|
-
# Simple Notification Service
|
7620
|
+
# Simple Notification Service, which is defined in the matchmaking
|
7512
7621
|
# configuration.
|
7513
7622
|
#
|
7514
7623
|
# **Learn more**
|
@@ -7533,7 +7642,7 @@ module Aws::GameLift
|
|
7533
7642
|
#
|
7534
7643
|
# @option params [String] :ticket_id
|
7535
7644
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
7536
|
-
# specified here, Amazon
|
7645
|
+
# specified here, Amazon Web Services will generate one in the form of a
|
7537
7646
|
# UUID. Use this identifier to track the matchmaking ticket status and
|
7538
7647
|
# retrieve match results.
|
7539
7648
|
#
|
@@ -7658,7 +7767,7 @@ module Aws::GameLift
|
|
7658
7767
|
#
|
7659
7768
|
# @option params [String] :location
|
7660
7769
|
# The fleet location to stop fleet actions for. Specify a location in
|
7661
|
-
# the form of an
|
7770
|
+
# the form of an Amazon Web Services Region code, such as `us-west-2`.
|
7662
7771
|
#
|
7663
7772
|
# @return [Types::StopFleetActionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7664
7773
|
#
|
@@ -7888,12 +7997,12 @@ module Aws::GameLift
|
|
7888
7997
|
req.send_request(options)
|
7889
7998
|
end
|
7890
7999
|
|
7891
|
-
# Assigns a tag to a GameLift resource.
|
7892
|
-
# additional management tool set. You can use tags to
|
7893
|
-
# resources, create IAM permissions policies to manage access
|
7894
|
-
# of resources, customize
|
7895
|
-
# handles the permissions necessary to manage tags
|
7896
|
-
# GameLift resource types:
|
8000
|
+
# Assigns a tag to a GameLift resource. Amazon Web Services resource
|
8001
|
+
# tags provide an additional management tool set. You can use tags to
|
8002
|
+
# organize resources, create IAM permissions policies to manage access
|
8003
|
+
# to groups of resources, customize Amazon Web Services cost breakdowns,
|
8004
|
+
# etc. This operation handles the permissions necessary to manage tags
|
8005
|
+
# for the following GameLift resource types:
|
7897
8006
|
#
|
7898
8007
|
# * Build
|
7899
8008
|
#
|
@@ -7916,9 +8025,10 @@ module Aws::GameLift
|
|
7916
8025
|
#
|
7917
8026
|
# **Learn more**
|
7918
8027
|
#
|
7919
|
-
# [Tagging
|
8028
|
+
# [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
|
8029
|
+
# General Reference*
|
7920
8030
|
#
|
7921
|
-
# [
|
8031
|
+
# [ Amazon Web Services Tagging Strategies][2]
|
7922
8032
|
#
|
7923
8033
|
# **Related actions**
|
7924
8034
|
#
|
@@ -7946,7 +8056,7 @@ module Aws::GameLift
|
|
7946
8056
|
# A list of one or more tags to assign to the specified GameLift
|
7947
8057
|
# resource. Tags are developer-defined and structured as key-value
|
7948
8058
|
# pairs. The maximum tag limit may be lower than stated. See [ Tagging
|
7949
|
-
#
|
8059
|
+
# Amazon Web Services Resources][1] for actual tagging limits.
|
7950
8060
|
#
|
7951
8061
|
#
|
7952
8062
|
#
|
@@ -7976,9 +8086,9 @@ module Aws::GameLift
|
|
7976
8086
|
end
|
7977
8087
|
|
7978
8088
|
# Removes a tag that is assigned to a GameLift resource. Resource tags
|
7979
|
-
# are used to organize
|
7980
|
-
# operation handles the permissions necessary to manage
|
7981
|
-
# following GameLift resource types:
|
8089
|
+
# are used to organize Amazon Web Services resources for a range of
|
8090
|
+
# purposes. This operation handles the permissions necessary to manage
|
8091
|
+
# tags for the following GameLift resource types:
|
7982
8092
|
#
|
7983
8093
|
# * Build
|
7984
8094
|
#
|
@@ -8001,9 +8111,10 @@ module Aws::GameLift
|
|
8001
8111
|
#
|
8002
8112
|
# **Learn more**
|
8003
8113
|
#
|
8004
|
-
# [Tagging
|
8114
|
+
# [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
|
8115
|
+
# General Reference*
|
8005
8116
|
#
|
8006
|
-
# [
|
8117
|
+
# [ Amazon Web Services Tagging Strategies][2]
|
8007
8118
|
#
|
8008
8119
|
# **Related actions**
|
8009
8120
|
#
|
@@ -8029,8 +8140,9 @@ module Aws::GameLift
|
|
8029
8140
|
#
|
8030
8141
|
# @option params [required, Array<String>] :tag_keys
|
8031
8142
|
# A list of one or more tag keys to remove from the specified GameLift
|
8032
|
-
# resource. An
|
8033
|
-
# key, so specifying the tag key identifies which tag to
|
8143
|
+
# resource. An Amazon Web Services resource can have only one tag with a
|
8144
|
+
# specific tag key, so specifying the tag key identifies which tag to
|
8145
|
+
# remove.
|
8034
8146
|
#
|
8035
8147
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
8036
8148
|
#
|
@@ -8282,12 +8394,12 @@ module Aws::GameLift
|
|
8282
8394
|
# whether the capacity is changed manually or through automatic
|
8283
8395
|
# scaling.
|
8284
8396
|
#
|
8285
|
-
# * Desired capacity: Manually set the number of EC2 instances to
|
8286
|
-
# maintained in a fleet location. Before changing a fleet's
|
8287
|
-
# capacity, you may want to call DescribeEC2InstanceLimits to
|
8288
|
-
# maximum capacity of the fleet's EC2 instance type.
|
8289
|
-
# consider using automatic scaling to adjust capacity
|
8290
|
-
# demand.
|
8397
|
+
# * Desired capacity: Manually set the number of Amazon EC2 instances to
|
8398
|
+
# be maintained in a fleet location. Before changing a fleet's
|
8399
|
+
# desired capacity, you may want to call DescribeEC2InstanceLimits to
|
8400
|
+
# get the maximum capacity of the fleet's Amazon EC2 instance type.
|
8401
|
+
# Alternatively, consider using automatic scaling to adjust capacity
|
8402
|
+
# based on player demand.
|
8291
8403
|
#
|
8292
8404
|
# This operation can be used in the following ways:
|
8293
8405
|
#
|
@@ -8331,9 +8443,9 @@ module Aws::GameLift
|
|
8331
8443
|
# can use either the fleet ID or ARN value.
|
8332
8444
|
#
|
8333
8445
|
# @option params [Integer] :desired_instances
|
8334
|
-
# The number of EC2 instances you want to maintain in the
|
8335
|
-
# fleet location. This value must fall between the minimum and
|
8336
|
-
# size limits.
|
8446
|
+
# The number of Amazon EC2 instances you want to maintain in the
|
8447
|
+
# specified fleet location. This value must fall between the minimum and
|
8448
|
+
# maximum size limits.
|
8337
8449
|
#
|
8338
8450
|
# @option params [Integer] :min_size
|
8339
8451
|
# The minimum number of instances that are allowed in the specified
|
@@ -8345,7 +8457,7 @@ module Aws::GameLift
|
|
8345
8457
|
#
|
8346
8458
|
# @option params [String] :location
|
8347
8459
|
# The name of a remote location to update fleet capacity settings for,
|
8348
|
-
# in the form of an
|
8460
|
+
# in the form of an Amazon Web Services Region code such as `us-west-2`.
|
8349
8461
|
#
|
8350
8462
|
# @return [Types::UpdateFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8351
8463
|
#
|
@@ -8600,24 +8712,24 @@ module Aws::GameLift
|
|
8600
8712
|
#
|
8601
8713
|
# @option params [String] :role_arn
|
8602
8714
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
8603
|
-
#
|
8715
|
+
# Web Services to access your Amazon EC2 Auto Scaling groups.
|
8604
8716
|
#
|
8605
8717
|
#
|
8606
8718
|
#
|
8607
8719
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
8608
8720
|
#
|
8609
8721
|
# @option params [Array<Types::InstanceDefinition>] :instance_definitions
|
8610
|
-
# An updated list of EC2 instance types to use in the Auto
|
8611
|
-
# group. The instance definitions must specify at least two
|
8612
|
-
# instance types that are supported by GameLift FleetIQ. This
|
8613
|
-
# list replaces the entire current list of instance definitions
|
8614
|
-
# game server group. For more information on instance types, see
|
8615
|
-
# Instance Types][1] in the *Amazon EC2 User Guide*. You can
|
8616
|
-
# specify capacity weighting for each instance type. If no
|
8617
|
-
# is specified for an instance type, it is set to the
|
8618
|
-
# "1". For more information about capacity weighting,
|
8619
|
-
# Weighting for Amazon EC2 Auto Scaling][2] in the Amazon
|
8620
|
-
# Scaling User Guide.
|
8722
|
+
# An updated list of Amazon EC2 instance types to use in the Auto
|
8723
|
+
# Scaling group. The instance definitions must specify at least two
|
8724
|
+
# different instance types that are supported by GameLift FleetIQ. This
|
8725
|
+
# updated list replaces the entire current list of instance definitions
|
8726
|
+
# for the game server group. For more information on instance types, see
|
8727
|
+
# [EC2 Instance Types][1] in the *Amazon EC2 User Guide*. You can
|
8728
|
+
# optionally specify capacity weighting for each instance type. If no
|
8729
|
+
# weight value is specified for an instance type, it is set to the
|
8730
|
+
# default value "1". For more information about capacity weighting,
|
8731
|
+
# see [ Instance Weighting for Amazon EC2 Auto Scaling][2] in the Amazon
|
8732
|
+
# EC2 Auto Scaling User Guide.
|
8621
8733
|
#
|
8622
8734
|
#
|
8623
8735
|
#
|
@@ -8632,8 +8744,8 @@ module Aws::GameLift
|
|
8632
8744
|
# instances cannot be terminated while there are active game servers
|
8633
8745
|
# running except in the event of a forced game server group deletion
|
8634
8746
|
# (see ). An exception to this is with Spot Instances, which can be
|
8635
|
-
# terminated by
|
8636
|
-
# set to `NO_PROTECTION` by default.
|
8747
|
+
# terminated by Amazon Web Services regardless of protection status.
|
8748
|
+
# This property is set to `NO_PROTECTION` by default.
|
8637
8749
|
#
|
8638
8750
|
# @option params [String] :balancing_strategy
|
8639
8751
|
# Indicates how GameLift FleetIQ balances the use of Spot Instances and
|
@@ -8805,14 +8917,18 @@ module Aws::GameLift
|
|
8805
8917
|
#
|
8806
8918
|
# **Related actions**
|
8807
8919
|
#
|
8808
|
-
# CreateGameSessionQueue \| DescribeGameSessionQueues \|
|
8809
|
-
# UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All
|
8810
|
-
# task][
|
8920
|
+
# [CreateGameSessionQueue][2] \| [DescribeGameSessionQueues][3] \|
|
8921
|
+
# [UpdateGameSessionQueue][4] \| [DeleteGameSessionQueue][5] \| [All
|
8922
|
+
# APIs by task][6]
|
8811
8923
|
#
|
8812
8924
|
#
|
8813
8925
|
#
|
8814
8926
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
8815
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
8927
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html
|
8928
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html
|
8929
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html
|
8930
|
+
# [5]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html
|
8931
|
+
# [6]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
|
8816
8932
|
#
|
8817
8933
|
# @option params [required, String] :name
|
8818
8934
|
# A descriptive label that is associated with game session queue. Queue
|
@@ -8843,10 +8959,10 @@ module Aws::GameLift
|
|
8843
8959
|
#
|
8844
8960
|
# @option params [Types::FilterConfiguration] :filter_configuration
|
8845
8961
|
# A list of locations where a queue is allowed to place new game
|
8846
|
-
# sessions. Locations are specified in the form of
|
8847
|
-
# such as `us-west-2`. If this parameter is not set, game
|
8848
|
-
# be placed in any queue location. To remove an existing
|
8849
|
-
# configuration, pass in an empty set.
|
8962
|
+
# sessions. Locations are specified in the form of Amazon Web Services
|
8963
|
+
# Region codes, such as `us-west-2`. If this parameter is not set, game
|
8964
|
+
# sessions can be placed in any queue location. To remove an existing
|
8965
|
+
# filter configuration, pass in an empty set.
|
8850
8966
|
#
|
8851
8967
|
# @option params [Types::PriorityConfiguration] :priority_configuration
|
8852
8968
|
# Custom settings to use when prioritizing destinations and locations
|
@@ -9221,13 +9337,13 @@ module Aws::GameLift
|
|
9221
9337
|
# the *Version* parameter to track updates to the script.
|
9222
9338
|
#
|
9223
9339
|
# If the call is successful, the updated metadata is stored in the
|
9224
|
-
# script record and a revised script is uploaded to the Amazon
|
9225
|
-
# service. Once the script is updated and acquired by a fleet
|
9226
|
-
# the new version is used for all new game sessions.
|
9340
|
+
# script record and a revised script is uploaded to the Amazon Web
|
9341
|
+
# Services service. Once the script is updated and acquired by a fleet
|
9342
|
+
# instance, the new version is used for all new game sessions.
|
9227
9343
|
#
|
9228
9344
|
# **Learn more**
|
9229
9345
|
#
|
9230
|
-
# [Amazon
|
9346
|
+
# [Amazon Web Services Realtime Servers][1]
|
9231
9347
|
#
|
9232
9348
|
# **Related actions**
|
9233
9349
|
#
|
@@ -9255,21 +9371,22 @@ module Aws::GameLift
|
|
9255
9371
|
# The location of the Amazon S3 bucket where a zipped file containing
|
9256
9372
|
# your Realtime scripts is stored. The storage location must specify the
|
9257
9373
|
# Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
|
9258
|
-
# that allows Amazon
|
9259
|
-
# The S3 bucket must be in the same Region where you want to
|
9260
|
-
# new script. By default, Amazon
|
9261
|
-
# the zip file; if you have S3 object versioning
|
9262
|
-
# the `ObjectVersion` parameter to specify an
|
9374
|
+
# that allows Amazon Web Services to access the Amazon S3 storage
|
9375
|
+
# location. The S3 bucket must be in the same Region where you want to
|
9376
|
+
# create a new script. By default, Amazon Web Services uploads the
|
9377
|
+
# latest version of the zip file; if you have S3 object versioning
|
9378
|
+
# turned on, you can use the `ObjectVersion` parameter to specify an
|
9379
|
+
# earlier version.
|
9263
9380
|
#
|
9264
9381
|
# @option params [String, StringIO, File] :zip_file
|
9265
9382
|
# A data object containing your Realtime scripts and dependencies as a
|
9266
9383
|
# zip file. The zip file can have one or multiple files. Maximum size of
|
9267
9384
|
# a zip file is 5 MB.
|
9268
9385
|
#
|
9269
|
-
# When using the
|
9270
|
-
# to the zip file name. It must be prepended with the
|
9271
|
-
# "fileb://" to indicate that the file data is a binary object.
|
9272
|
-
# example: `--zip-file fileb://myRealtimeScript.zip`.
|
9386
|
+
# When using the Amazon Web Services CLI tool to create a script, this
|
9387
|
+
# parameter is set to the zip file name. It must be prepended with the
|
9388
|
+
# string "fileb://" to indicate that the file data is a binary object.
|
9389
|
+
# For example: `--zip-file fileb://myRealtimeScript.zip`.
|
9273
9390
|
#
|
9274
9391
|
# @return [Types::UpdateScriptOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9275
9392
|
#
|
@@ -9376,7 +9493,7 @@ module Aws::GameLift
|
|
9376
9493
|
params: params,
|
9377
9494
|
config: config)
|
9378
9495
|
context[:gem_name] = 'aws-sdk-gamelift'
|
9379
|
-
context[:gem_version] = '1.
|
9496
|
+
context[:gem_version] = '1.54.0'
|
9380
9497
|
Seahorse::Client::Request.new(handlers, context)
|
9381
9498
|
end
|
9382
9499
|
|