aws-sdk-gamelift 1.50.0 → 1.54.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
31
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
30
32
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
33
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
34
 
@@ -73,6 +75,8 @@ module Aws::GameLift
73
75
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
76
  add_plugin(Aws::Plugins::TransferEncoding)
75
77
  add_plugin(Aws::Plugins::HttpChecksum)
78
+ add_plugin(Aws::Plugins::DefaultsMode)
79
+ add_plugin(Aws::Plugins::RecursionDetection)
76
80
  add_plugin(Aws::Plugins::SignatureV4)
77
81
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
78
82
 
@@ -119,7 +123,9 @@ module Aws::GameLift
119
123
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
124
  # are very aggressive. Construct and pass an instance of
121
125
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
126
+ # enable retries and extended timeouts. Instance profile credential
127
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
128
+ # to true.
123
129
  #
124
130
  # @option options [required, String] :region
125
131
  # The AWS region to connect to. The configured `:region` is
@@ -173,6 +179,10 @@ module Aws::GameLift
173
179
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
180
  # a clock skew correction and retry requests with skewed client clocks.
175
181
  #
182
+ # @option options [String] :defaults_mode ("legacy")
183
+ # See {Aws::DefaultsModeConfiguration} for a list of the
184
+ # accepted modes and the configuration defaults that are included.
185
+ #
176
186
  # @option options [Boolean] :disable_host_prefix_injection (false)
177
187
  # Set to true to disable SDK automatically adding host prefix
178
188
  # to default service endpoint when available.
@@ -305,7 +315,7 @@ module Aws::GameLift
305
315
  # seconds to wait when opening a HTTP session before raising a
306
316
  # `Timeout::Error`.
307
317
  #
308
- # @option options [Integer] :http_read_timeout (60) The default
318
+ # @option options [Float] :http_read_timeout (60) The default
309
319
  # number of seconds to wait for response data. This value can
310
320
  # safely be set per-request on the session.
311
321
  #
@@ -321,6 +331,9 @@ module Aws::GameLift
321
331
  # disables this behaviour. This value can safely be set per
322
332
  # request on the session.
323
333
  #
334
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
335
+ # in seconds.
336
+ #
324
337
  # @option options [Boolean] :http_wire_trace (false) When `true`,
325
338
  # HTTP debug output will be sent to the `:logger`.
326
339
  #
@@ -532,12 +545,12 @@ module Aws::GameLift
532
545
  # for a fleet that is useful when redirecting player traffic from one
533
546
  # fleet to another, such as when updating your game build.
534
547
  #
535
- # Amazon GameLift supports two types of routing strategies for aliases:
536
- # simple and terminal. A simple alias points to an active fleet. A
537
- # terminal alias is used to display messaging or link to a URL instead
538
- # of routing players to an active fleet. For example, you might use a
539
- # terminal alias when a game version is no longer supported and you want
540
- # 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.
541
554
  #
542
555
  # To create a fleet alias, specify an alias name, routing strategy, and
543
556
  # optional description. Each simple alias can point to only one fleet,
@@ -567,12 +580,13 @@ module Aws::GameLift
567
580
  #
568
581
  # @option params [Array<Types::Tag>] :tags
569
582
  # A list of labels to assign to the new alias resource. Tags are
570
- # developer-defined key-value pairs. Tagging AWS resources are useful
571
- # for resource management, access management and cost allocation. For
572
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
573
- # Reference*. Once the resource is created, you can use TagResource,
574
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
575
- # The maximum tag limit may be lower than stated. See the AWS General
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
576
590
  # Reference for actual tagging limits.
577
591
  #
578
592
  #
@@ -622,12 +636,12 @@ module Aws::GameLift
622
636
  req.send_request(options)
623
637
  end
624
638
 
625
- # Creates a new Amazon GameLift build resource for your game server
639
+ # Creates a new Amazon Web Services build resource for your game server
626
640
  # binary files. Game server binaries must be combined into a zip file
627
- # for use with Amazon GameLift.
641
+ # for use with Amazon Web Services.
628
642
  #
629
643
  # When setting up a new game build for GameLift, we recommend using the
630
- # AWS CLI command <b> <a
644
+ # Amazon Web Services CLI command <b> <a
631
645
  # href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
632
646
  # </b>. This helper command combines two tasks: (1) it uploads your
633
647
  # build files from a file directory to a GameLift Amazon S3 location,
@@ -636,11 +650,11 @@ module Aws::GameLift
636
650
  # The `CreateBuild` operation can used in the following scenarios:
637
651
  #
638
652
  # * To create a new game build with build files that are in an Amazon S3
639
- # location under an AWS account that you control. To use this option,
640
- # you must first give Amazon GameLift access to the Amazon S3 bucket.
641
- # With permissions in place, call `CreateBuild` and specify a build
642
- # name, operating system, and the Amazon S3 storage location of your
643
- # 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.
644
658
  #
645
659
  # * To directly upload your build files to a GameLift Amazon S3
646
660
  # location. To use this option, first call `CreateBuild` and specify a
@@ -689,8 +703,13 @@ module Aws::GameLift
689
703
  # this parameter only when creating a build with files stored in an
690
704
  # Amazon S3 bucket that you own. The storage location must specify an
691
705
  # Amazon S3 bucket name and key. The location must also specify a role
692
- # ARN that you set up to allow Amazon GameLift to access your Amazon S3
693
- # bucket. The S3 bucket and your new build must be in the same Region.
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.
694
713
  #
695
714
  # @option params [String] :operating_system
696
715
  # The operating system that the game server binaries are built to run
@@ -702,12 +721,13 @@ module Aws::GameLift
702
721
  #
703
722
  # @option params [Array<Types::Tag>] :tags
704
723
  # A list of labels to assign to the new build resource. Tags are
705
- # developer-defined key-value pairs. Tagging AWS resources are useful
706
- # for resource management, access management and cost allocation. For
707
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
708
- # Reference*. Once the resource is created, you can use TagResource,
709
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
710
- # The maximum tag limit may be lower than stated. See the AWS General
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
711
731
  # Reference for actual tagging limits.
712
732
  #
713
733
  #
@@ -767,21 +787,23 @@ module Aws::GameLift
767
787
  req.send_request(options)
768
788
  end
769
789
 
770
- # Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances
771
- # to host your custom game server or Realtime Servers. Use this
772
- # operation to configure the computing resources for your fleet and
773
- # provide instructions for running game servers on each instance.
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.
774
795
  #
775
796
  # Most GameLift fleets can deploy instances to multiple locations,
776
797
  # including the home Region (where the fleet is created) and an optional
777
- # set of remote locations. Fleets that are created in the following AWS
778
- # Regions support multiple locations: us-east-1 (N. Virginia), us-west-2
779
- # (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),
780
- # ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2
781
- # (Seoul). Fleets that are created in other GameLift Regions can deploy
782
- # instances in the fleet's home Region only. All fleet instances use
783
- # the same configuration regardless of location; however, you can adjust
784
- # capacity settings and turn auto-scaling on/off for each location.
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.
785
807
  #
786
808
  # To create a fleet, choose the hardware for your instances, specify a
787
809
  # game server build or Realtime script to deploy, and provide a runtime
@@ -791,6 +813,12 @@ module Aws::GameLift
791
813
  # creating a multi-location fleet, provide a list of additional remote
792
814
  # locations.
793
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
+ #
794
822
  # If successful, this operation creates a new Fleet resource and places
795
823
  # it in `NEW` status, which prompts GameLift to initiate the [fleet
796
824
  # creation workflow][1]. You can track fleet creation by checking fleet
@@ -865,11 +893,11 @@ module Aws::GameLift
865
893
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process
866
894
  #
867
895
  # @option params [required, String] :ec2_instance_type
868
- # The GameLift-supported EC2 instance type to use for all fleet
896
+ # The GameLift-supported Amazon EC2 instance type to use for all fleet
869
897
  # instances. Instance type determines the computing resources that will
870
898
  # be used to host your game servers, including CPU, memory, storage, and
871
- # networking capacity. See [Amazon EC2 Instance Types][1] for detailed
872
- # 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.
873
901
  #
874
902
  #
875
903
  #
@@ -914,23 +942,24 @@ module Aws::GameLift
914
942
  # of time.
915
943
  #
916
944
  # @option params [Array<String>] :metric_groups
917
- # The name of an AWS CloudWatch metric group to add this fleet to. A
918
- # metric group is used to aggregate the metrics for multiple fleets. You
919
- # can specify an existing metric group name or set a new name to create
920
- # a new metric group. A fleet can be included in only one metric group
921
- # 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.
922
950
  #
923
951
  # @option params [String] :peer_vpc_aws_account_id
924
952
  # Used when peering your GameLift fleet with a VPC, the unique
925
- # identifier for the AWS account that owns the VPC. You can find your
926
- # account ID in the AWS Management Console under account settings.
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.
927
956
  #
928
957
  # @option params [String] :peer_vpc_id
929
958
  # A unique identifier for a VPC with resources to be accessed by your
930
959
  # GameLift fleet. The VPC must be in the same Region as your fleet. To
931
- # look up a VPC ID, use the [VPC Dashboard][1] in the AWS Management
932
- # Console. Learn more about VPC peering in [VPC Peering with GameLift
933
- # 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].
934
963
  #
935
964
  #
936
965
  #
@@ -948,15 +977,15 @@ module Aws::GameLift
948
977
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot
949
978
  #
950
979
  # @option params [String] :instance_role_arn
951
- # A unique identifier for an AWS IAM role that manages access to your
952
- # AWS services. With an instance role ARN set, any application that runs
953
- # on an instance in this fleet can assume the role, including install
954
- # scripts, server processes, and daemons (background processes). Create
955
- # a role or look up a role's ARN by using the [IAM dashboard][1] in the
956
- # AWS Management Console. Learn more about using on-box credentials for
957
- # your game servers at [ Access external resources from a game
958
- # server][2]. This property cannot be changed after the fleet is
959
- # 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.
960
989
  #
961
990
  #
962
991
  #
@@ -967,35 +996,33 @@ module Aws::GameLift
967
996
  # Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS
968
997
  # certificates are used for encrypting traffic between game clients and
969
998
  # the game servers that are running on GameLift. By default, the
970
- # `CertificateConfiguration` is set to `DISABLED`. Learn more at
971
- # [Securing Client/Server Communication][1]. This property cannot be
972
- # changed after the fleet is created.
973
- #
974
- # Note: This feature requires the AWS Certificate Manager (ACM) service,
975
- # which is not available in all AWS regions. When working in a region
976
- # that does not support this feature, a fleet creation request with
977
- # certificate generation fails with a 4xx error.
978
- #
999
+ # `CertificateConfiguration` is set to `DISABLED`. This property cannot
1000
+ # be changed after the fleet is created.
979
1001
  #
980
- #
981
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-howitworks.html#gamelift-howitworks-security
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.
982
1007
  #
983
1008
  # @option params [Array<Types::LocationConfiguration>] :locations
984
1009
  # A set of remote locations to deploy additional instances to and manage
985
1010
  # as part of the fleet. This parameter can only be used when creating
986
- # fleets in AWS Regions that support multiple locations. You can add any
987
- # GameLift-supported AWS Region as a remote location, in the form of an
988
- # AWS Region code such as `us-west-2`. To create a fleet with instances
989
- # in the home Region only, omit this parameter.
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.
990
1016
  #
991
1017
  # @option params [Array<Types::Tag>] :tags
992
1018
  # A list of labels to assign to the new fleet resource. Tags are
993
- # developer-defined key-value pairs. Tagging AWS resources are useful
994
- # for resource management, access management and cost allocation. For
995
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
996
- # Reference*. Once the fleet is created, you can use TagResource,
997
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
998
- # The maximum tag limit may be lower than stated. See the *AWS General
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
999
1026
  # Reference* for actual tagging limits.
1000
1027
  #
1001
1028
  #
@@ -1112,9 +1139,9 @@ module Aws::GameLift
1112
1139
  #
1113
1140
  # <note markdown="1"> This operation cannot be used with fleets that don't support remote
1114
1141
  # locations. Fleets can have multiple locations only if they reside in
1115
- # AWS Regions that support this feature (see CreateFleet for the
1116
- # complete list) and were created after the feature was released in
1117
- # 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.
1118
1145
  #
1119
1146
  # </note>
1120
1147
  #
@@ -1155,9 +1182,9 @@ module Aws::GameLift
1155
1182
  #
1156
1183
  # @option params [required, Array<Types::LocationConfiguration>] :locations
1157
1184
  # A list of locations to deploy additional instances to and manage as
1158
- # part of the fleet. You can add any GameLift-supported AWS Region as a
1159
- # remote location, in the form of an AWS Region code such as
1160
- # `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`.
1161
1188
  #
1162
1189
  # @return [Types::CreateFleetLocationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1163
1190
  #
@@ -1197,31 +1224,33 @@ module Aws::GameLift
1197
1224
  # server groups.**
1198
1225
  #
1199
1226
  # Creates a GameLift FleetIQ game server group for managing game hosting
1200
- # on a collection of Amazon EC2 instances for game hosting. This
1201
- # operation creates the game server group, creates an Auto Scaling group
1202
- # in your AWS account, and establishes a link between the two groups.
1203
- # You can view the status of your game server groups in the GameLift
1204
- # console. Game server group metrics and events are emitted to Amazon
1205
- # 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.
1206
1233
  #
1207
1234
  # Before creating a new game server group, you must have the following:
1208
1235
  #
1209
- # * An Amazon EC2 launch template that specifies how to launch Amazon
1210
- # EC2 instances with your game server build. For more information, see
1211
- # [ Launching an Instance from a Launch Template][1] in the *Amazon
1212
- # EC2 User Guide*.
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*.
1213
1241
  #
1214
- # * An IAM role that extends limited access to your AWS account to allow
1215
- # GameLift FleetIQ to create and interact with the Auto Scaling group.
1216
- # For more information, see [Create IAM roles for cross-service
1217
- # interaction][2] in the *GameLift FleetIQ Developer Guide*.
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*.
1218
1247
  #
1219
1248
  # To create a new game server group, specify a unique group name, IAM
1220
- # role and Amazon EC2 launch template, and provide a list of instance
1221
- # types that can be used in the group. You must also set initial maximum
1222
- # and minimum limits on the group's instance count. You can optionally
1223
- # set an Auto Scaling policy with target tracking based on a GameLift
1224
- # 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.
1225
1254
  #
1226
1255
  # Once the game server group and corresponding Auto Scaling group are
1227
1256
  # created, you have full access to change the Auto Scaling group's
@@ -1253,41 +1282,42 @@ module Aws::GameLift
1253
1282
  #
1254
1283
  # @option params [required, String] :game_server_group_name
1255
1284
  # An identifier for the new game server group. This value is used to
1256
- # generate unique ARN identifiers for the EC2 Auto Scaling group and the
1257
- # GameLift FleetIQ game server group. The name must be unique per Region
1258
- # per AWS account.
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.
1259
1288
  #
1260
1289
  # @option params [required, String] :role_arn
1261
1290
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
1262
- # GameLift to access your EC2 Auto Scaling groups.
1291
+ # Web Services to access your Amazon EC2 Auto Scaling groups.
1263
1292
  #
1264
1293
  #
1265
1294
  #
1266
1295
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
1267
1296
  #
1268
1297
  # @option params [required, Integer] :min_size
1269
- # The minimum number of instances allowed in the EC2 Auto Scaling group.
1270
- # During automatic scaling events, GameLift FleetIQ and EC2 do not scale
1271
- # down the group below this minimum. In production, this value should be
1272
- # set to at least 1. After the Auto Scaling group is created, update
1273
- # this value directly in the Auto Scaling group using the AWS console or
1274
- # 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.
1275
1304
  #
1276
1305
  # @option params [required, Integer] :max_size
1277
- # The maximum number of instances allowed in the EC2 Auto Scaling group.
1278
- # During automatic scaling events, GameLift FleetIQ and EC2 do not scale
1279
- # up the group above this maximum. After the Auto Scaling group is
1280
- # created, update this value directly in the Auto Scaling group using
1281
- # the AWS console or APIs.
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.
1282
1311
  #
1283
1312
  # @option params [required, Types::LaunchTemplateSpecification] :launch_template
1284
- # The EC2 launch template that contains configuration settings and game
1285
- # server code to be deployed to all instances in the game server group.
1286
- # You can specify the template using either the template name or ID. For
1287
- # help with creating a launch template, see [Creating a Launch Template
1288
- # for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
1289
- # Guide*. After the Auto Scaling group is created, update this value
1290
- # directly in the Auto Scaling group using the AWS console or APIs.
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.
1291
1321
  #
1292
1322
  # <note markdown="1"> If you specify network interfaces in your launch template, you must
1293
1323
  # explicitly set the property `AssociatePublicIpAddress` to "true". If
@@ -1301,15 +1331,16 @@ module Aws::GameLift
1301
1331
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
1302
1332
  #
1303
1333
  # @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
1304
- # The EC2 instance types and sizes to use in the Auto Scaling group. The
1305
- # instance definitions must specify at least two different instance
1306
- # types that are supported by GameLift FleetIQ. For more information on
1307
- # instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
1308
- # Guide*. You can optionally specify capacity weighting for each
1309
- # instance type. If no weight value is specified for an instance type,
1310
- # it is set to the default value "1". For more information about
1311
- # capacity weighting, see [ Instance Weighting for Amazon EC2 Auto
1312
- # Scaling][2] in the Amazon EC2 Auto Scaling User Guide.
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.
1313
1344
  #
1314
1345
  #
1315
1346
  #
@@ -1322,7 +1353,7 @@ module Aws::GameLift
1322
1353
  # metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
1323
1354
  # game servers that can immediately accommodate new games and players.
1324
1355
  # After the Auto Scaling group is created, update this value directly in
1325
- # the Auto Scaling group using the AWS console or APIs.
1356
+ # the Auto Scaling group using the Amazon Web Services console or APIs.
1326
1357
  #
1327
1358
  # @option params [String] :balancing_strategy
1328
1359
  # Indicates how GameLift FleetIQ balances the use of Spot Instances and
@@ -1355,8 +1386,8 @@ module Aws::GameLift
1355
1386
  # instances cannot be terminated while there are active game servers
1356
1387
  # running except in the event of a forced game server group deletion
1357
1388
  # (see ). An exception to this is with Spot Instances, which can be
1358
- # terminated by AWS regardless of protection status. This property is
1359
- # 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.
1360
1391
  #
1361
1392
  # @option params [Array<String>] :vpc_subnets
1362
1393
  # A list of virtual private cloud (VPC) subnets to use with instances in
@@ -1369,13 +1400,14 @@ module Aws::GameLift
1369
1400
  #
1370
1401
  # @option params [Array<Types::Tag>] :tags
1371
1402
  # A list of labels to assign to the new game server group resource. Tags
1372
- # are developer-defined key-value pairs. Tagging AWS resources is useful
1373
- # for resource management, access management, and cost allocation. For
1374
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
1375
- # Reference*. Once the resource is created, you can use TagResource,
1376
- # UntagResource, and ListTagsForResource to add, remove, and view tags,
1377
- # respectively. The maximum tag limit may be lower than stated. See the
1378
- # AWS General Reference for actual tagging limits.
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.
1379
1411
  #
1380
1412
  #
1381
1413
  #
@@ -1484,7 +1516,7 @@ module Aws::GameLift
1484
1516
  # days. To access the logs, call GetGameSessionLogUrl to download the
1485
1517
  # log files.
1486
1518
  #
1487
- # *Available in GameLift Local.*
1519
+ # *Available in Amazon Web Services Local.*
1488
1520
  #
1489
1521
  # **Learn more**
1490
1522
  #
@@ -1524,7 +1556,12 @@ module Aws::GameLift
1524
1556
  # @option params [Array<Types::GameProperty>] :game_properties
1525
1557
  # A set of custom properties for a game session, formatted as key:value
1526
1558
  # pairs. These properties are passed to a game server process in the
1527
- # 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
1528
1565
  #
1529
1566
  # @option params [String] :creator_id
1530
1567
  # A unique identifier for a player or entity creating the game session.
@@ -1556,13 +1593,18 @@ module Aws::GameLift
1556
1593
  # @option params [String] :game_session_data
1557
1594
  # A set of custom game session properties, formatted as a single string
1558
1595
  # value. This data is passed to a game server process in the GameSession
1559
- # 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
1560
1602
  #
1561
1603
  # @option params [String] :location
1562
1604
  # A fleet's remote location to place the new game session in. If this
1563
1605
  # parameter is not set, the new game session is placed in the fleet's
1564
- # home Region. Specify a remote location with an AWS Region code such as
1565
- # `us-west-2`.
1606
+ # home Region. Specify a remote location with an Amazon Web Services
1607
+ # Region code such as `us-west-2`.
1566
1608
  #
1567
1609
  # @return [Types::CreateGameSessionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1568
1610
  #
@@ -1629,10 +1671,10 @@ module Aws::GameLift
1629
1671
  # A game session queue is configured with a set of destinations
1630
1672
  # (GameLift fleets or aliases), which determine the locations where the
1631
1673
  # queue can place new game sessions. These destinations can span
1632
- # multiple fleet types (Spot and On-Demand), instance types, and AWS
1633
- # Regions. If the queue includes multi-location fleets, the queue is
1634
- # able to place game sessions in all of a fleet's remote locations. You
1635
- # 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.
1636
1678
  #
1637
1679
  # The queue configuration also determines how FleetIQ selects the best
1638
1680
  # available placement for a new game session. Before searching for an
@@ -1651,26 +1693,32 @@ module Aws::GameLift
1651
1693
  #
1652
1694
  # If successful, a new `GameSessionQueue` object is returned with an
1653
1695
  # assigned queue ARN. New game session requests, which are submitted to
1654
- # the queue with StartGameSessionPlacement or StartMatchmaking,
1696
+ # queue with [StartGameSessionPlacement][1] or [StartMatchmaking][2],
1655
1697
  # reference a queue's name or ARN.
1656
1698
  #
1657
1699
  # **Learn more**
1658
1700
  #
1659
- # [ Design a game session queue][1]
1701
+ # [ Design a game session queue][3]
1660
1702
  #
1661
- # [ Create a game session queue][2]
1703
+ # [ Create a game session queue][4]
1662
1704
  #
1663
1705
  # **Related actions**
1664
1706
  #
1665
- # CreateGameSessionQueue \| DescribeGameSessionQueues \|
1666
- # UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All APIs by
1667
- # task][3]
1707
+ # [CreateGameSessionQueue][5] \| [DescribeGameSessionQueues][6] \|
1708
+ # [UpdateGameSessionQueue][7] \| [DeleteGameSessionQueue][8] \| [All
1709
+ # APIs by task][9]
1668
1710
  #
1669
1711
  #
1670
1712
  #
1671
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html
1672
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html
1673
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
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
1674
1722
  #
1675
1723
  # @option params [required, String] :name
1676
1724
  # A descriptive label that is associated with game session queue. Queue
@@ -1698,9 +1746,9 @@ module Aws::GameLift
1698
1746
  #
1699
1747
  # @option params [Types::FilterConfiguration] :filter_configuration
1700
1748
  # A list of locations where a queue is allowed to place new game
1701
- # sessions. Locations are specified in the form of AWS Region codes,
1702
- # such as `us-west-2`. If this parameter is not set, game sessions can
1703
- # 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.
1704
1752
  #
1705
1753
  # @option params [Types::PriorityConfiguration] :priority_configuration
1706
1754
  # Custom settings to use when prioritizing destinations and locations
@@ -1724,13 +1772,14 @@ module Aws::GameLift
1724
1772
  #
1725
1773
  # @option params [Array<Types::Tag>] :tags
1726
1774
  # A list of labels to assign to the new game session queue resource.
1727
- # Tags are developer-defined key-value pairs. Tagging AWS resources are
1728
- # useful for resource management, access management and cost allocation.
1729
- # For more information, see [ Tagging AWS Resources][1] in the *AWS
1730
- # General Reference*. Once the resource is created, you can use
1731
- # TagResource, UntagResource, and ListTagsForResource to add, remove,
1732
- # and view tags. The maximum tag limit may be lower than stated. See the
1733
- # AWS General Reference for actual tagging limits.
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.
1734
1783
  #
1735
1784
  #
1736
1785
  #
@@ -1821,10 +1870,10 @@ module Aws::GameLift
1821
1870
  # queue to use when starting a game session for the match.
1822
1871
  #
1823
1872
  # In addition, you must set up an Amazon Simple Notification Service
1824
- # (SNS) topic to receive matchmaking notifications. Provide the topic
1825
- # ARN in the matchmaking configuration. An alternative method,
1826
- # continuously polling ticket status with DescribeMatchmaking, is only
1827
- # suitable for games in development with low matchmaking usage.
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.
1828
1877
  #
1829
1878
  # **Learn more**
1830
1879
  #
@@ -1965,13 +2014,14 @@ module Aws::GameLift
1965
2014
  #
1966
2015
  # @option params [Array<Types::Tag>] :tags
1967
2016
  # A list of labels to assign to the new matchmaking configuration
1968
- # resource. Tags are developer-defined key-value pairs. Tagging AWS
1969
- # resources are useful for resource management, access management and
1970
- # cost allocation. For more information, see [ Tagging AWS Resources][1]
1971
- # in the *AWS General Reference*. Once the resource is created, you can
1972
- # use TagResource, UntagResource, and ListTagsForResource to add,
1973
- # remove, and view tags. The maximum tag limit may be lower than stated.
1974
- # See the AWS General Reference for actual tagging limits.
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.
1975
2025
  #
1976
2026
  #
1977
2027
  #
@@ -2093,13 +2143,14 @@ module Aws::GameLift
2093
2143
  #
2094
2144
  # @option params [Array<Types::Tag>] :tags
2095
2145
  # A list of labels to assign to the new matchmaking rule set resource.
2096
- # Tags are developer-defined key-value pairs. Tagging AWS resources are
2097
- # useful for resource management, access management and cost allocation.
2098
- # For more information, see [ Tagging AWS Resources][1] in the *AWS
2099
- # General Reference*. Once the resource is created, you can use
2100
- # TagResource, UntagResource, and ListTagsForResource to add, remove,
2101
- # and view tags. The maximum tag limit may be lower than stated. See the
2102
- # AWS General Reference for actual tagging limits.
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.
2103
2154
  #
2104
2155
  #
2105
2156
  #
@@ -2154,7 +2205,10 @@ module Aws::GameLift
2154
2205
  # validate the player reservation with the GameLift service. Player
2155
2206
  # sessions cannot be updated.
2156
2207
  #
2157
- # *Available in Amazon GameLift Local.*
2208
+ # The maximum number of players per game session is 200. It is not
2209
+ # adjustable.
2210
+ #
2211
+ # *Available in Amazon Web Services Local.*
2158
2212
  #
2159
2213
  # **Related actions**
2160
2214
  #
@@ -2229,7 +2283,10 @@ module Aws::GameLift
2229
2283
  # to validate the player reservation with the GameLift service. Player
2230
2284
  # sessions cannot be updated.
2231
2285
  #
2232
- # *Available in Amazon GameLift Local.*
2286
+ # The maximum number of players per game session is 200. It is not
2287
+ # adjustable.
2288
+ #
2289
+ # *Available in Amazon Web Services Local.*
2233
2290
  #
2234
2291
  # **Related actions**
2235
2292
  #
@@ -2249,10 +2306,10 @@ module Aws::GameLift
2249
2306
  #
2250
2307
  # @option params [Hash<String,String>] :player_data_map
2251
2308
  # Map of string pairs, each specifying a player ID and a set of
2252
- # developer-defined information related to the player. Amazon GameLift
2253
- # does not use this data, so it can be formatted as needed for use in
2254
- # the game. Any player data strings for player IDs that are not included
2255
- # 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.
2256
2313
  #
2257
2314
  # @return [Types::CreatePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2258
2315
  #
@@ -2307,23 +2364,24 @@ module Aws::GameLift
2307
2364
  # * A locally available directory. Use the *ZipFile* parameter for this
2308
2365
  # option.
2309
2366
  #
2310
- # * An Amazon Simple Storage Service (Amazon S3) bucket under your AWS
2311
- # account. Use the *StorageLocation* parameter for this option.
2312
- # You'll need to have an Identity Access Management (IAM) role that
2313
- # allows the Amazon GameLift service to access your S3 bucket.
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.
2314
2372
  #
2315
2373
  # If the call is successful, a new script record is created with a
2316
2374
  # unique script ID. If the script file is provided as a local file, the
2317
- # file is uploaded to an Amazon GameLift-owned S3 bucket and the script
2318
- # record's storage location reflects this location. If the script file
2319
- # is provided as an S3 bucket, Amazon GameLift accesses the file at this
2320
- # 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.
2321
2379
  #
2322
2380
  # **Learn more**
2323
2381
  #
2324
- # [Amazon GameLift Realtime Servers][1]
2382
+ # [Amazon Web Services Realtime Servers][1]
2325
2383
  #
2326
- # [Set Up a Role for Amazon GameLift Access][2]
2384
+ # [Set Up a Role for Amazon Web Services Access][2]
2327
2385
  #
2328
2386
  # **Related actions**
2329
2387
  #
@@ -2350,30 +2408,32 @@ module Aws::GameLift
2350
2408
  # The location of the Amazon S3 bucket where a zipped file containing
2351
2409
  # your Realtime scripts is stored. The storage location must specify the
2352
2410
  # Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
2353
- # that allows Amazon GameLift to access the Amazon S3 storage location.
2354
- # The S3 bucket must be in the same Region where you want to create a
2355
- # new script. By default, Amazon GameLift uploads the latest version of
2356
- # the zip file; if you have S3 object versioning turned on, you can use
2357
- # the `ObjectVersion` parameter to specify an earlier version.
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.
2358
2417
  #
2359
2418
  # @option params [String, StringIO, File] :zip_file
2360
2419
  # A data object containing your Realtime scripts and dependencies as a
2361
2420
  # zip file. The zip file can have one or multiple files. Maximum size of
2362
2421
  # a zip file is 5 MB.
2363
2422
  #
2364
- # When using the AWS CLI tool to create a script, this parameter is set
2365
- # to the zip file name. It must be prepended with the string
2366
- # "fileb://" to indicate that the file data is a binary object. For
2367
- # 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`.
2368
2427
  #
2369
2428
  # @option params [Array<Types::Tag>] :tags
2370
2429
  # A list of labels to assign to the new script resource. Tags are
2371
- # developer-defined key-value pairs. Tagging AWS resources are useful
2372
- # for resource management, access management and cost allocation. For
2373
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
2374
- # Reference*. Once the resource is created, you can use TagResource,
2375
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
2376
- # The maximum tag limit may be lower than stated. See the AWS General
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
2377
2437
  # Reference for actual tagging limits.
2378
2438
  #
2379
2439
  #
@@ -2427,32 +2487,35 @@ module Aws::GameLift
2427
2487
  end
2428
2488
 
2429
2489
  # Requests authorization to create or delete a peer connection between
2430
- # the VPC for your Amazon GameLift fleet and a virtual private cloud
2431
- # (VPC) in your AWS account. VPC peering enables the game servers on
2432
- # your fleet to communicate directly with other AWS resources. Once
2433
- # you've received authorization, call CreateVpcPeeringConnection to
2434
- # establish the peering connection. For more information, see [VPC
2435
- # Peering with Amazon GameLift Fleets][1].
2436
- #
2437
- # You can peer with VPCs that are owned by any AWS account you have
2438
- # access to, including the account that you use to manage your Amazon
2439
- # GameLift fleets. You cannot peer with VPCs that are in different
2440
- # Regions.
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.
2441
2502
  #
2442
2503
  # To request authorization to create a connection, call this operation
2443
- # from the AWS account with the VPC that you want to peer to your Amazon
2444
- # GameLift fleet. For example, to enable your game servers to retrieve
2445
- # data from a DynamoDB table, use the account that manages that DynamoDB
2446
- # resource. Identify the following values: (1) The ID of the VPC that
2447
- # you want to peer with, and (2) the ID of the AWS account that you use
2448
- # to manage Amazon GameLift. If successful, VPC peering is authorized
2449
- # for the specified VPC.
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.
2450
2512
  #
2451
2513
  # To request authorization to delete a connection, call this operation
2452
- # from the AWS account with the VPC that is peered with your Amazon
2453
- # GameLift fleet. Identify the following values: (1) VPC ID that you
2454
- # want to delete the peering connection for, and (2) ID of the AWS
2455
- # account that you use to manage Amazon GameLift.
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.
2456
2519
  #
2457
2520
  # The authorization remains valid for 24 hours unless it is canceled by
2458
2521
  # a call to DeleteVpcPeeringAuthorization. You must create or delete the
@@ -2471,16 +2534,16 @@ module Aws::GameLift
2471
2534
  # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
2472
2535
  #
2473
2536
  # @option params [required, String] :game_lift_aws_account_id
2474
- # A unique identifier for the AWS account that you use to manage your
2475
- # GameLift fleet. You can find your Account ID in the AWS Management
2476
- # 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.
2477
2540
  #
2478
2541
  # @option params [required, String] :peer_vpc_id
2479
2542
  # A unique identifier for a VPC with resources to be accessed by your
2480
2543
  # GameLift fleet. The VPC must be in the same Region as your fleet. To
2481
- # look up a VPC ID, use the [VPC Dashboard][1] in the AWS Management
2482
- # Console. Learn more about VPC peering in [VPC Peering with GameLift
2483
- # 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].
2484
2547
  #
2485
2548
  #
2486
2549
  #
@@ -2516,13 +2579,14 @@ module Aws::GameLift
2516
2579
  end
2517
2580
 
2518
2581
  # Establishes a VPC peering connection between a virtual private cloud
2519
- # (VPC) in an AWS account with the VPC for your Amazon GameLift fleet.
2520
- # VPC peering enables the game servers on your fleet to communicate
2521
- # directly with other AWS resources. You can peer with VPCs in any AWS
2522
- # account that you have access to, including the account that you use to
2523
- # manage your Amazon GameLift fleets. You cannot peer with VPCs that are
2524
- # in different Regions. For more information, see [VPC Peering with
2525
- # Amazon GameLift Fleets][1].
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].
2526
2590
  #
2527
2591
  # Before calling this operation to establish the peering connection, you
2528
2592
  # first need to call CreateVpcPeeringAuthorization and identify the VPC
@@ -2531,16 +2595,16 @@ module Aws::GameLift
2531
2595
  # operations handle all tasks necessary to peer the two VPCs, including
2532
2596
  # acceptance, updating routing tables, etc.
2533
2597
  #
2534
- # To establish the connection, call this operation from the AWS account
2535
- # that is used to manage the Amazon GameLift fleets. Identify the
2536
- # following values: (1) The ID of the fleet you want to be enable a VPC
2537
- # peering connection for; (2) The AWS account with the VPC that you want
2538
- # to peer with; and (3) The ID of the VPC you want to peer with. This
2539
- # operation is asynchronous. If successful, a VpcPeeringConnection
2540
- # request is created. You can use continuous polling to track the
2541
- # request's status using DescribeVpcPeeringConnections, or by
2542
- # monitoring fleet events for success or failure using
2543
- # 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.
2544
2608
  #
2545
2609
  # **Related actions**
2546
2610
  #
@@ -2556,19 +2620,21 @@ module Aws::GameLift
2556
2620
  #
2557
2621
  # @option params [required, String] :fleet_id
2558
2622
  # A unique identifier for the fleet. You can use either the fleet ID or
2559
- # ARN value. This tells Amazon GameLift which GameLift VPC to peer with.
2623
+ # ARN value. This tells Amazon Web Services which GameLift VPC to peer
2624
+ # with.
2560
2625
  #
2561
2626
  # @option params [required, String] :peer_vpc_aws_account_id
2562
- # A unique identifier for the AWS account with the VPC that you want to
2563
- # peer your Amazon GameLift fleet with. You can find your Account ID in
2564
- # the AWS Management Console under account settings.
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.
2565
2631
  #
2566
2632
  # @option params [required, String] :peer_vpc_id
2567
2633
  # A unique identifier for a VPC with resources to be accessed by your
2568
2634
  # GameLift fleet. The VPC must be in the same Region as your fleet. To
2569
- # look up a VPC ID, use the [VPC Dashboard][1] in the AWS Management
2570
- # Console. Learn more about VPC peering in [VPC Peering with GameLift
2571
- # 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].
2572
2638
  #
2573
2639
  #
2574
2640
  #
@@ -2761,7 +2827,7 @@ module Aws::GameLift
2761
2827
  #
2762
2828
  # @option params [required, Array<String>] :locations
2763
2829
  # The list of fleet locations to delete. Specify locations in the form
2764
- # of an AWS Region code, such as `us-west-2`.
2830
+ # of an Amazon Web Services Region code, such as `us-west-2`.
2765
2831
  #
2766
2832
  # @return [Types::DeleteFleetLocationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2767
2833
  #
@@ -2847,16 +2913,16 @@ module Aws::GameLift
2847
2913
  # @option params [String] :delete_option
2848
2914
  # The type of delete to perform. Options include the following:
2849
2915
  #
2850
- # * `SAFE_DELETE` – (default) Terminates the game server group and EC2
2851
- # Auto Scaling group only when it has no game servers that are in
2852
- # `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.
2853
2919
  #
2854
2920
  # * `FORCE_DELETE` – Terminates the game server group, including all
2855
2921
  # active game servers regardless of their utilization status, and the
2856
- # EC2 Auto Scaling group.
2922
+ # Amazon EC2 Auto Scaling group.
2857
2923
  #
2858
2924
  # * `RETAIN` – Does a safe delete of the game server group but retains
2859
- # the EC2 Auto Scaling group as is.
2925
+ # the Amazon EC2 Auto Scaling group as is.
2860
2926
  #
2861
2927
  # @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2862
2928
  #
@@ -2897,23 +2963,28 @@ module Aws::GameLift
2897
2963
  end
2898
2964
 
2899
2965
  # Deletes a game session queue. Once a queue is successfully deleted,
2900
- # unfulfilled StartGameSessionPlacement requests that reference the
2966
+ # unfulfilled [StartGameSessionPlacement][1] requests that reference the
2901
2967
  # queue will fail. To delete a queue, specify the queue name.
2902
2968
  #
2903
2969
  # **Learn more**
2904
2970
  #
2905
- # [ Using Multi-Region Queues][1]
2971
+ # [ Using Multi-Region Queues][2]
2906
2972
  #
2907
2973
  # **Related actions**
2908
2974
  #
2909
- # CreateGameSessionQueue \| DescribeGameSessionQueues \|
2910
- # UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All APIs by
2911
- # task][2]
2975
+ # [CreateGameSessionQueue][3] \| [DescribeGameSessionQueues][4] \|
2976
+ # [UpdateGameSessionQueue][5] \| [DeleteGameSessionQueue][6] \| [All
2977
+ # APIs by task][7]
2912
2978
  #
2913
2979
  #
2914
2980
  #
2915
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
2916
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
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
2917
2988
  #
2918
2989
  # @option params [required, String] :name
2919
2990
  # A descriptive label that is associated with game session queue. Queue
@@ -3076,7 +3147,7 @@ module Aws::GameLift
3076
3147
  #
3077
3148
  # **Learn more**
3078
3149
  #
3079
- # [Amazon GameLift Realtime Servers][1]
3150
+ # [Amazon Web Services Realtime Servers][1]
3080
3151
  #
3081
3152
  # **Related actions**
3082
3153
  #
@@ -3125,16 +3196,16 @@ module Aws::GameLift
3125
3196
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
3126
3197
  #
3127
3198
  # @option params [required, String] :game_lift_aws_account_id
3128
- # A unique identifier for the AWS account that you use to manage your
3129
- # GameLift fleet. You can find your Account ID in the AWS Management
3130
- # 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.
3131
3202
  #
3132
3203
  # @option params [required, String] :peer_vpc_id
3133
3204
  # A unique identifier for a VPC with resources to be accessed by your
3134
3205
  # GameLift fleet. The VPC must be in the same Region as your fleet. To
3135
- # look up a VPC ID, use the [VPC Dashboard][1] in the AWS Management
3136
- # Console. Learn more about VPC peering in [VPC Peering with GameLift
3137
- # 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].
3138
3209
  #
3139
3210
  #
3140
3211
  #
@@ -3165,10 +3236,10 @@ module Aws::GameLift
3165
3236
  # DescribeVpcPeeringAuthorizations or request a new one using
3166
3237
  # CreateVpcPeeringAuthorization.
3167
3238
  #
3168
- # Once a valid authorization exists, call this operation from the AWS
3169
- # account that is used to manage the Amazon GameLift fleets. Identify
3170
- # the connection to delete by the connection ID and fleet ID. If
3171
- # 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.
3172
3243
  #
3173
3244
  # **Related actions**
3174
3245
  #
@@ -3364,22 +3435,23 @@ module Aws::GameLift
3364
3435
  req.send_request(options)
3365
3436
  end
3366
3437
 
3367
- # The GameLift service limits and current utilization for an AWS Region
3368
- # or location. Instance limits control the number of instances, per
3369
- # instance type, per location, that your AWS account can use. Learn more
3370
- # at [Amazon EC2 Instance Types][1]. The information returned includes
3371
- # the maximum number of instances allowed and your account's current
3372
- # usage across all fleets. This information can affect your ability to
3373
- # scale your GameLift fleets. You can request a limit increase for your
3374
- # account by using the **Service limits** page in the GameLift console.
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.
3375
3447
  #
3376
3448
  # Instance limits differ based on whether the instances are deployed in
3377
3449
  # a fleet's home Region or in a remote location. For remote locations,
3378
3450
  # limits also differ based on the combination of home Region and remote
3379
- # location. All requests must specify an AWS Region (either explicitly
3380
- # or as your default settings). To get the limit for a remote location,
3381
- # you must also specify the location. For example, the following
3382
- # 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:
3383
3455
  #
3384
3456
  # * Request specifies the Region `ap-northeast-1` with no location. The
3385
3457
  # result is limits and usage data on all instance types that are
@@ -3400,14 +3472,15 @@ module Aws::GameLift
3400
3472
  # This operation can be used in the following ways:
3401
3473
  #
3402
3474
  # * To get limit and usage data for all instance types that are deployed
3403
- # in an AWS Region by fleets that reside in the same Region: Specify
3404
- # the Region only. Optionally, specify a single instance type to
3405
- # 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.
3406
3478
  #
3407
3479
  # * To get limit and usage data for all instance types that are deployed
3408
- # to a remote location by fleets that reside in different AWS Region:
3409
- # Provide both the AWS Region and the remote location. Optionally,
3410
- # specify a single instance type to retrieve information for.
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.
3411
3484
  #
3412
3485
  # If successful, an `EC2InstanceLimits` object is returned with limits
3413
3486
  # and usage data for each requested instance type.
@@ -3430,15 +3503,15 @@ module Aws::GameLift
3430
3503
  # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
3431
3504
  #
3432
3505
  # @option params [String] :ec2_instance_type
3433
- # Name of an EC2 instance type that is supported in GameLift. A fleet
3434
- # instance type determines the computing resources of each instance in
3435
- # the fleet, including CPU, memory, storage, and networking capacity. Do
3436
- # not specify a value for this parameter to retrieve limits for all
3437
- # 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.
3438
3511
  #
3439
3512
  # @option params [String] :location
3440
3513
  # The name of a remote location to request instance limits for, in the
3441
- # form of an AWS Region code such as `us-west-2`.
3514
+ # form of an Amazon Web Services Region code such as `us-west-2`.
3442
3515
  #
3443
3516
  # @return [Types::DescribeEC2InstanceLimitsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3444
3517
  #
@@ -3826,7 +3899,8 @@ module Aws::GameLift
3826
3899
  #
3827
3900
  # @option params [Array<String>] :locations
3828
3901
  # A list of fleet locations to retrieve information for. Specify
3829
- # locations in the form of an AWS Region code, such as `us-west-2`.
3902
+ # locations in the form of an Amazon Web Services Region code, such as
3903
+ # `us-west-2`.
3830
3904
  #
3831
3905
  # @option params [Integer] :limit
3832
3906
  # The maximum number of results to return. Use this parameter with
@@ -3916,7 +3990,8 @@ module Aws::GameLift
3916
3990
  #
3917
3991
  # @option params [required, String] :location
3918
3992
  # The fleet location to retrieve capacity information for. Specify a
3919
- # location in the form of an AWS Region code, such as `us-west-2`.
3993
+ # location in the form of an Amazon Web Services Region code, such as
3994
+ # `us-west-2`.
3920
3995
  #
3921
3996
  # @return [Types::DescribeFleetLocationCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3922
3997
  #
@@ -3989,7 +4064,8 @@ module Aws::GameLift
3989
4064
  #
3990
4065
  # @option params [required, String] :location
3991
4066
  # The fleet location to retrieve utilization information for. Specify a
3992
- # location in the form of an AWS Region code, such as `us-west-2`.
4067
+ # location in the form of an Amazon Web Services Region code, such as
4068
+ # `us-west-2`.
3993
4069
  #
3994
4070
  # @return [Types::DescribeFleetLocationUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3995
4071
  #
@@ -4064,7 +4140,7 @@ module Aws::GameLift
4064
4140
  #
4065
4141
  # @option params [String] :location
4066
4142
  # A remote location to check for status of port setting updates. Use the
4067
- # AWS Region code format, such as `us-west-2`.
4143
+ # Amazon Web Services Region code format, such as `us-west-2`.
4068
4144
  #
4069
4145
  # @return [Types::DescribeFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4070
4146
  #
@@ -4385,10 +4461,10 @@ module Aws::GameLift
4385
4461
  # GameServerGroup name or ARN value.
4386
4462
  #
4387
4463
  # @option params [Array<String>] :instance_ids
4388
- # The EC2 instance IDs that you want to retrieve status on. EC2 instance
4389
- # IDs use a 17-character format, for example: `i-1234567890abcdef0`. To
4390
- # retrieve all instances in the game server group, leave this parameter
4391
- # 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.
4392
4468
  #
4393
4469
  # @option params [Integer] :limit
4394
4470
  # The maximum number of results to return. Use this parameter with
@@ -4456,7 +4532,8 @@ module Aws::GameLift
4456
4532
  #
4457
4533
  # * To retrieve details for a specific game session, provide the game
4458
4534
  # session ID. This approach looks for the game session ID in all
4459
- # fleets that reside in the AWS Region defined in the request.
4535
+ # fleets that reside in the Amazon Web Services Region defined in the
4536
+ # request.
4460
4537
  #
4461
4538
  # Use the pagination parameters to retrieve results as a set of
4462
4539
  # sequential pages.
@@ -4495,8 +4572,8 @@ module Aws::GameLift
4495
4572
  #
4496
4573
  # @option params [String] :location
4497
4574
  # A fleet location to get game sessions for. You can specify a fleet's
4498
- # home Region or a remote location. Use the AWS Region code format, such
4499
- # 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`.
4500
4577
  #
4501
4578
  # @option params [String] :status_filter
4502
4579
  # Game session status to filter results on. Possible game session
@@ -4573,6 +4650,14 @@ module Aws::GameLift
4573
4650
  #
4574
4651
  # To get game session placement details, specify the placement ID.
4575
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
+ #
4576
4661
  # If successful, a GameSessionPlacement object is returned.
4577
4662
  #
4578
4663
  # **Related actions**
@@ -4650,14 +4735,18 @@ module Aws::GameLift
4650
4735
  #
4651
4736
  # **Related actions**
4652
4737
  #
4653
- # CreateGameSessionQueue \| DescribeGameSessionQueues \|
4654
- # UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All APIs by
4655
- # task][2]
4738
+ # [CreateGameSessionQueue][2] \| [DescribeGameSessionQueues][3] \|
4739
+ # [UpdateGameSessionQueue][4] \| [DeleteGameSessionQueue][5] \| [All
4740
+ # APIs by task][6]
4656
4741
  #
4657
4742
  #
4658
4743
  #
4659
4744
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html
4660
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
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
4661
4750
  #
4662
4751
  # @option params [Array<String>] :names
4663
4752
  # A list of queue names to retrieve information for. You can use either
@@ -4727,6 +4816,14 @@ module Aws::GameLift
4727
4816
  # retrieve the protection policy for game sessions, use
4728
4817
  # DescribeGameSessionDetails.
4729
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
+ #
4730
4827
  # This operation can be used in the following ways:
4731
4828
  #
4732
4829
  # * To retrieve all game sessions that are currently running on all
@@ -4741,7 +4838,7 @@ module Aws::GameLift
4741
4838
  #
4742
4839
  # * To retrieve a specific game session, provide the game session ID.
4743
4840
  # This approach looks for the game session ID in all fleets that
4744
- # reside in the AWS Region defined in the request.
4841
+ # reside in the Amazon Web Services Region defined in the request.
4745
4842
  #
4746
4843
  # Use the pagination parameters to retrieve results as a set of
4747
4844
  # sequential pages.
@@ -4749,7 +4846,15 @@ module Aws::GameLift
4749
4846
  # If successful, a `GameSession` object is returned for each game
4750
4847
  # session that matches the request.
4751
4848
  #
4752
- # *Available in GameLift Local.*
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.*
4753
4858
  #
4754
4859
  # **Learn more**
4755
4860
  #
@@ -4782,8 +4887,8 @@ module Aws::GameLift
4782
4887
  #
4783
4888
  # @option params [String] :location
4784
4889
  # A fleet location to get game session details for. You can specify a
4785
- # fleet's home Region or a remote location. Use the AWS Region code
4786
- # 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`.
4787
4892
  #
4788
4893
  # @option params [String] :status_filter
4789
4894
  # Game session status to filter results on. You can filter on the
@@ -4912,7 +5017,7 @@ module Aws::GameLift
4912
5017
  #
4913
5018
  # @option params [String] :location
4914
5019
  # The name of a location to retrieve instance information for, in the
4915
- # form of an AWS Region code such as `us-west-2`.
5020
+ # form of an Amazon Web Services Region code such as `us-west-2`.
4916
5021
  #
4917
5022
  # @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4918
5023
  #
@@ -4966,11 +5071,10 @@ module Aws::GameLift
4966
5071
  # This operation is not designed to be continually called to track
4967
5072
  # matchmaking ticket status. This practice can cause you to exceed your
4968
5073
  # API limit, which results in errors. Instead, as a best practice, set
4969
- # up an Amazon Simple Notification Service (SNS) to receive
4970
- # notifications, and provide the topic ARN in the matchmaking
4971
- # configuration. Continuously poling ticket status with
4972
- # DescribeMatchmaking should only be used for games in development with
4973
- # 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.
4974
5078
  #
4975
5079
  #
4976
5080
  #
@@ -5237,7 +5341,7 @@ module Aws::GameLift
5237
5341
  # If successful, a `PlayerSession` object is returned for each session
5238
5342
  # that matches the request.
5239
5343
  #
5240
- # *Available in Amazon GameLift Local.*
5344
+ # *Available in Amazon Web Services Local.*
5241
5345
  #
5242
5346
  # **Related actions**
5243
5347
  #
@@ -5422,8 +5526,8 @@ module Aws::GameLift
5422
5526
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
5423
5527
  #
5424
5528
  # @option params [required, String] :fleet_id
5425
- # A unique identifier for the fleet to retrieve scaling policies for.
5426
- # 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.
5427
5531
  #
5428
5532
  # @option params [String] :status_filter
5429
5533
  # Scaling policy status to filter results on. A scaling policy is only
@@ -5457,7 +5561,8 @@ module Aws::GameLift
5457
5561
  # a value.
5458
5562
  #
5459
5563
  # @option params [String] :location
5460
- # CONTENT TODO
5564
+ # The fleet location. If you don't specify this value, the response
5565
+ # contains the scaling policies of every location in the fleet.
5461
5566
  #
5462
5567
  # @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5463
5568
  #
@@ -5511,7 +5616,7 @@ module Aws::GameLift
5511
5616
  #
5512
5617
  # **Learn more**
5513
5618
  #
5514
- # [Amazon GameLift Realtime Servers][1]
5619
+ # [Amazon Web Services Realtime Servers][1]
5515
5620
  #
5516
5621
  # **Related actions**
5517
5622
  #
@@ -5560,9 +5665,9 @@ module Aws::GameLift
5560
5665
  end
5561
5666
 
5562
5667
  # Retrieves valid VPC peering authorizations that are pending for the
5563
- # AWS account. This operation returns all VPC peering authorizations and
5564
- # requests for peering. This includes those initiated and received by
5565
- # 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.
5566
5671
  #
5567
5672
  # **Related actions**
5568
5673
  #
@@ -5601,12 +5706,12 @@ module Aws::GameLift
5601
5706
  # to get peering information for all fleets or for one specific fleet
5602
5707
  # ID.
5603
5708
  #
5604
- # To retrieve connection information, call this operation from the AWS
5605
- # account that is used to manage the Amazon GameLift fleets. Specify a
5606
- # fleet ID or leave the parameter empty to retrieve all connection
5607
- # records. If successful, the retrieved information includes both active
5608
- # and pending connections. Active connections identify the IpV4 CIDR
5609
- # 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.
5610
5715
  #
5611
5716
  # **Related actions**
5612
5717
  #
@@ -5659,8 +5764,8 @@ module Aws::GameLift
5659
5764
  # automatically stores the logs in Amazon S3 and retains them for 14
5660
5765
  # days. Use this URL to download the logs.
5661
5766
  #
5662
- # <note markdown="1"> See the [AWS Service Limits][1] page for maximum log file sizes. Log
5663
- # 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.
5664
5769
  #
5665
5770
  # </note>
5666
5771
  #
@@ -5713,9 +5818,9 @@ module Aws::GameLift
5713
5818
  # Remote Desktop client. For a Linux instance, GameLift returns a user
5714
5819
  # name and RSA private key, also as strings, for use with an SSH client.
5715
5820
  # The private key must be saved in the proper format to a `.pem` file
5716
- # before using. If you're making this request using the AWS CLI, saving
5717
- # the secret can be handled as part of the `GetInstanceAccess` request,
5718
- # as shown in one of the examples for this operation.
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.
5719
5824
  #
5720
5825
  # To request access to a specific instance, specify the IDs of both the
5721
5826
  # instance and the fleet it belongs to. You can retrieve a fleet's
@@ -5780,9 +5885,9 @@ module Aws::GameLift
5780
5885
  req.send_request(options)
5781
5886
  end
5782
5887
 
5783
- # Retrieves all aliases for this AWS account. You can filter the result
5784
- # set by alias name and/or routing strategy type. Use the pagination
5785
- # 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.
5786
5891
  #
5787
5892
  # <note markdown="1"> Returned aliases are not listed in any particular order.
5788
5893
  #
@@ -5865,10 +5970,11 @@ module Aws::GameLift
5865
5970
  req.send_request(options)
5866
5971
  end
5867
5972
 
5868
- # Retrieves build resources for all builds associated with the AWS
5869
- # account in use. You can limit results to builds that are in a specific
5870
- # status by using the `Status` parameter. Use the pagination parameters
5871
- # to retrieve results in a set of sequential pages.
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.
5872
5978
  #
5873
5979
  # <note markdown="1"> Build resources are not listed in any particular order.
5874
5980
  #
@@ -5952,9 +6058,9 @@ module Aws::GameLift
5952
6058
  req.send_request(options)
5953
6059
  end
5954
6060
 
5955
- # Retrieves a collection of fleet resources in an AWS Region. You can
5956
- # call this operation to get fleets in a previously selected default
5957
- # 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
5958
6064
  # [https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html][1]or
5959
6065
  # specify a Region in your request. You can filter the result set to
5960
6066
  # find only those fleets that are deployed with a specific build or
@@ -6055,8 +6161,9 @@ module Aws::GameLift
6055
6161
  # server groups.**
6056
6162
  #
6057
6163
  # Retrieves information on all game servers groups that exist in the
6058
- # current AWS account for the selected Region. Use the pagination
6059
- # parameters to retrieve results in a set of sequential segments.
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.
6060
6167
  #
6061
6168
  # **Learn more**
6062
6169
  #
@@ -6214,11 +6321,11 @@ module Aws::GameLift
6214
6321
  end
6215
6322
 
6216
6323
  # Retrieves script records for all Realtime scripts that are associated
6217
- # with the AWS account in use.
6324
+ # with the Amazon Web Services account in use.
6218
6325
  #
6219
6326
  # **Learn more**
6220
6327
  #
6221
- # [Amazon GameLift Realtime Servers][1]
6328
+ # [Amazon Web Services Realtime Servers][1]
6222
6329
  #
6223
6330
  # **Related actions**
6224
6331
  #
@@ -6279,9 +6386,9 @@ module Aws::GameLift
6279
6386
  end
6280
6387
 
6281
6388
  # Retrieves all tags that are assigned to a GameLift resource. Resource
6282
- # tags are used to organize AWS resources for a range of purposes. This
6283
- # operation handles the permissions necessary to manage tags for the
6284
- # 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:
6285
6392
  #
6286
6393
  # * Build
6287
6394
  #
@@ -6302,9 +6409,10 @@ module Aws::GameLift
6302
6409
  #
6303
6410
  # **Learn more**
6304
6411
  #
6305
- # [Tagging AWS Resources][1] in the *AWS General Reference*
6412
+ # [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
6413
+ # General Reference*
6306
6414
  #
6307
- # [ AWS Tagging Strategies][2]
6415
+ # [ Amazon Web Services Tagging Strategies][2]
6308
6416
  #
6309
6417
  # **Related actions**
6310
6418
  #
@@ -6355,13 +6463,13 @@ module Aws::GameLift
6355
6463
 
6356
6464
  # Creates or updates a scaling policy for a fleet. Scaling policies are
6357
6465
  # used to automatically scale a fleet's hosting capacity to meet player
6358
- # demand. An active scaling policy instructs Amazon GameLift to track a
6359
- # fleet metric and automatically change the fleet's capacity when a
6360
- # certain threshold is reached. There are two types of scaling policies:
6361
- # target-based and rule-based. Use a target-based policy to quickly and
6362
- # efficiently manage fleet scaling; this option is the most commonly
6363
- # used. Use rule-based policies when you need to exert fine-grained
6364
- # 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.
6365
6473
  #
6366
6474
  # Fleets can have multiple scaling policies of each type in force at the
6367
6475
  # same time; you can have one target-based policy, one or multiple
@@ -6386,15 +6494,15 @@ module Aws::GameLift
6386
6494
  # currently in use. This is the fleet's buffer; it measures the
6387
6495
  # additional player demand that the fleet could handle at current
6388
6496
  # capacity. With a target-based policy, you set your ideal buffer size
6389
- # and leave it to Amazon GameLift to take whatever action is needed to
6390
- # maintain that target.
6497
+ # and leave it to Amazon Web Services to take whatever action is needed
6498
+ # to maintain that target.
6391
6499
  #
6392
6500
  # For example, you might choose to maintain a 10% buffer for a fleet
6393
6501
  # that has the capacity to host 100 simultaneous game sessions. This
6394
- # policy tells Amazon GameLift to take action whenever the fleet's
6502
+ # policy tells Amazon Web Services to take action whenever the fleet's
6395
6503
  # available capacity falls below or rises above 10 game sessions. Amazon
6396
- # GameLift will start new instances or stop unused instances in order to
6397
- # 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.
6398
6506
  #
6399
6507
  # To create or update a target-based policy, specify a fleet ID and
6400
6508
  # name, and set the policy type to "TargetBased". Specify the metric
@@ -6490,9 +6598,9 @@ module Aws::GameLift
6490
6598
  # threshold before a scaling event is triggered.
6491
6599
  #
6492
6600
  # @option params [required, String] :metric_name
6493
- # Name of the Amazon GameLift-defined metric that is used to trigger a
6494
- # scaling adjustment. For detailed descriptions of fleet metrics, see
6495
- # [Monitor Amazon GameLift with Amazon CloudWatch][1].
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].
6496
6604
  #
6497
6605
  # * **ActivatingGameSessions** -- Game sessions in the process of being
6498
6606
  # created.
@@ -6621,7 +6729,7 @@ module Aws::GameLift
6621
6729
  # @option params [required, String] :game_server_id
6622
6730
  # A custom string that uniquely identifies the game server to register.
6623
6731
  # Game server IDs are developer-defined and must be unique across all
6624
- # game server groups in your AWS account.
6732
+ # game server groups in your Amazon Web Services account.
6625
6733
  #
6626
6734
  # @option params [required, String] :instance_id
6627
6735
  # The unique identifier for the instance where the game server is
@@ -6677,8 +6785,8 @@ module Aws::GameLift
6677
6785
  end
6678
6786
 
6679
6787
  # Retrieves a fresh set of credentials for use when uploading a new set
6680
- # of game build files to Amazon GameLift's Amazon S3. This is done as
6681
- # 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.
6682
6790
  #
6683
6791
  # To request new credentials, specify the build ID as returned with an
6684
6792
  # initial `CreateBuild` request. If successful, a new set of credentials
@@ -6854,6 +6962,14 @@ module Aws::GameLift
6854
6962
  # Retrieves all active game sessions that match a set of search criteria
6855
6963
  # and sorts them into a specified order.
6856
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
+ #
6857
6973
  # When searching for game sessions, you specify exactly where you want
6858
6974
  # to search and provide a search filter expression, a sort expression,
6859
6975
  # or both. A search request can search only one fleet, but it can search
@@ -6948,8 +7064,8 @@ module Aws::GameLift
6948
7064
  #
6949
7065
  # @option params [String] :location
6950
7066
  # A fleet location to search for game sessions. You can specify a
6951
- # fleet's home Region or a remote location. Use the AWS Region code
6952
- # 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`.
6953
7069
  #
6954
7070
  # @option params [String] :filter_expression
6955
7071
  # String containing the search criteria for the session search. If no
@@ -7125,7 +7241,7 @@ module Aws::GameLift
7125
7241
  #
7126
7242
  # @option params [String] :location
7127
7243
  # The fleet location to restart fleet actions for. Specify a location in
7128
- # the form of an AWS Region code, such as `us-west-2`.
7244
+ # the form of an Amazon Web Services Region code, such as `us-west-2`.
7129
7245
  #
7130
7246
  # @return [Types::StartFleetActionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7131
7247
  #
@@ -7156,26 +7272,26 @@ module Aws::GameLift
7156
7272
 
7157
7273
  # Places a request for a new game session in a queue (see
7158
7274
  # CreateGameSessionQueue). When processing a placement request, Amazon
7159
- # GameLift searches for available resources on the queue's
7275
+ # Web Services searches for available resources on the queue's
7160
7276
  # destinations, scanning each until it finds resources or the placement
7161
7277
  # request times out.
7162
7278
  #
7163
7279
  # A game session placement request can also request player sessions.
7164
- # When a new game session is successfully created, Amazon GameLift
7280
+ # When a new game session is successfully created, Amazon Web Services
7165
7281
  # creates a player session for each player included in the request.
7166
7282
  #
7167
- # When placing a game session, by default Amazon GameLift tries each
7283
+ # When placing a game session, by default Amazon Web Services tries each
7168
7284
  # fleet in the order they are listed in the queue configuration.
7169
7285
  # Ideally, a queue's destinations are listed in preference order.
7170
7286
  #
7171
7287
  # Alternatively, when requesting a game session with players, you can
7172
7288
  # also provide latency data for each player in relevant Regions. Latency
7173
7289
  # data indicates the performance lag a player experiences when connected
7174
- # to a fleet in the Region. Amazon GameLift uses latency data to reorder
7175
- # the list of destinations to place the game session in a Region with
7176
- # minimal lag. If latency data is provided for multiple players, Amazon
7177
- # GameLift calculates each Region's average lag for all players and
7178
- # 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.
7179
7295
  #
7180
7296
  # To place a new game session request, specify the following:
7181
7297
  #
@@ -7242,7 +7358,7 @@ module Aws::GameLift
7242
7358
  #
7243
7359
  # @option params [Array<Types::PlayerLatency>] :player_latencies
7244
7360
  # A set of values, expressed in milliseconds, that indicates the amount
7245
- # of latency that a player experiences when connected to AWS Regions.
7361
+ # of latency that a player experiences when connected to @aws; Regions.
7246
7362
  # This information is used to try to place the new game session where it
7247
7363
  # can offer the best possible gameplay experience for the players.
7248
7364
  #
@@ -7361,6 +7477,9 @@ module Aws::GameLift
7361
7477
  # and returned with status set to QUEUED. Track the status of backfill
7362
7478
  # tickets using the same method for tracking tickets for new matches.
7363
7479
  #
7480
+ # Only game sessions created by FlexMatch are supported for match
7481
+ # backfill.
7482
+ #
7364
7483
  # **Learn more**
7365
7484
  #
7366
7485
  # [ Backfill existing games with FlexMatch][1]
@@ -7383,7 +7502,7 @@ module Aws::GameLift
7383
7502
  #
7384
7503
  # @option params [String] :ticket_id
7385
7504
  # A unique identifier for a matchmaking ticket. If no ticket ID is
7386
- # specified here, Amazon GameLift will generate one in the form of a
7505
+ # specified here, Amazon Web Services will generate one in the form of a
7387
7506
  # UUID. Use this identifier to track the match backfill ticket status
7388
7507
  # and retrieve match results.
7389
7508
  #
@@ -7409,6 +7528,9 @@ module Aws::GameLift
7409
7528
  # matchmaker data is in JSON syntax, formatted as a string. For more
7410
7529
  # details, see [ Match Data][1].
7411
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
+ #
7412
7534
  # * LatencyInMs -- If the matchmaker uses player latency, include a
7413
7535
  # latency value, in milliseconds, for the Region that the game session
7414
7536
  # is currently in. Do not include latency values for any other Region.
@@ -7495,7 +7617,7 @@ module Aws::GameLift
7495
7617
  # Track matchmaking events to respond as needed and acquire game session
7496
7618
  # connection information for successfully completed matches. Ticket
7497
7619
  # status updates are tracked using event notification through Amazon
7498
- # Simple Notification Service (SNS), which is defined in the matchmaking
7620
+ # Simple Notification Service, which is defined in the matchmaking
7499
7621
  # configuration.
7500
7622
  #
7501
7623
  # **Learn more**
@@ -7520,7 +7642,7 @@ module Aws::GameLift
7520
7642
  #
7521
7643
  # @option params [String] :ticket_id
7522
7644
  # A unique identifier for a matchmaking ticket. If no ticket ID is
7523
- # specified here, Amazon GameLift will generate one in the form of a
7645
+ # specified here, Amazon Web Services will generate one in the form of a
7524
7646
  # UUID. Use this identifier to track the matchmaking ticket status and
7525
7647
  # retrieve match results.
7526
7648
  #
@@ -7645,7 +7767,7 @@ module Aws::GameLift
7645
7767
  #
7646
7768
  # @option params [String] :location
7647
7769
  # The fleet location to stop fleet actions for. Specify a location in
7648
- # the form of an AWS Region code, such as `us-west-2`.
7770
+ # the form of an Amazon Web Services Region code, such as `us-west-2`.
7649
7771
  #
7650
7772
  # @return [Types::StopFleetActionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7651
7773
  #
@@ -7875,12 +7997,12 @@ module Aws::GameLift
7875
7997
  req.send_request(options)
7876
7998
  end
7877
7999
 
7878
- # Assigns a tag to a GameLift resource. AWS resource tags provide an
7879
- # additional management tool set. You can use tags to organize
7880
- # resources, create IAM permissions policies to manage access to groups
7881
- # of resources, customize AWS cost breakdowns, etc. This operation
7882
- # handles the permissions necessary to manage tags for the following
7883
- # 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:
7884
8006
  #
7885
8007
  # * Build
7886
8008
  #
@@ -7903,9 +8025,10 @@ module Aws::GameLift
7903
8025
  #
7904
8026
  # **Learn more**
7905
8027
  #
7906
- # [Tagging AWS Resources][1] in the *AWS General Reference*
8028
+ # [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
8029
+ # General Reference*
7907
8030
  #
7908
- # [ AWS Tagging Strategies][2]
8031
+ # [ Amazon Web Services Tagging Strategies][2]
7909
8032
  #
7910
8033
  # **Related actions**
7911
8034
  #
@@ -7933,7 +8056,7 @@ module Aws::GameLift
7933
8056
  # A list of one or more tags to assign to the specified GameLift
7934
8057
  # resource. Tags are developer-defined and structured as key-value
7935
8058
  # pairs. The maximum tag limit may be lower than stated. See [ Tagging
7936
- # AWS Resources][1] for actual tagging limits.
8059
+ # Amazon Web Services Resources][1] for actual tagging limits.
7937
8060
  #
7938
8061
  #
7939
8062
  #
@@ -7963,9 +8086,9 @@ module Aws::GameLift
7963
8086
  end
7964
8087
 
7965
8088
  # Removes a tag that is assigned to a GameLift resource. Resource tags
7966
- # are used to organize AWS resources for a range of purposes. This
7967
- # operation handles the permissions necessary to manage tags for the
7968
- # 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:
7969
8092
  #
7970
8093
  # * Build
7971
8094
  #
@@ -7988,9 +8111,10 @@ module Aws::GameLift
7988
8111
  #
7989
8112
  # **Learn more**
7990
8113
  #
7991
- # [Tagging AWS Resources][1] in the *AWS General Reference*
8114
+ # [Tagging Amazon Web Services Resources][1] in the *Amazon Web Services
8115
+ # General Reference*
7992
8116
  #
7993
- # [ AWS Tagging Strategies][2]
8117
+ # [ Amazon Web Services Tagging Strategies][2]
7994
8118
  #
7995
8119
  # **Related actions**
7996
8120
  #
@@ -8016,8 +8140,9 @@ module Aws::GameLift
8016
8140
  #
8017
8141
  # @option params [required, Array<String>] :tag_keys
8018
8142
  # A list of one or more tag keys to remove from the specified GameLift
8019
- # resource. An AWS resource can have only one tag with a specific tag
8020
- # key, so specifying the tag key identifies which tag to remove.
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.
8021
8146
  #
8022
8147
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
8023
8148
  #
@@ -8269,12 +8394,12 @@ module Aws::GameLift
8269
8394
  # whether the capacity is changed manually or through automatic
8270
8395
  # scaling.
8271
8396
  #
8272
- # * Desired capacity: Manually set the number of EC2 instances to be
8273
- # maintained in a fleet location. Before changing a fleet's desired
8274
- # capacity, you may want to call DescribeEC2InstanceLimits to get the
8275
- # maximum capacity of the fleet's EC2 instance type. Alternatively,
8276
- # consider using automatic scaling to adjust capacity based on player
8277
- # 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.
8278
8403
  #
8279
8404
  # This operation can be used in the following ways:
8280
8405
  #
@@ -8318,9 +8443,9 @@ module Aws::GameLift
8318
8443
  # can use either the fleet ID or ARN value.
8319
8444
  #
8320
8445
  # @option params [Integer] :desired_instances
8321
- # The number of EC2 instances you want to maintain in the specified
8322
- # fleet location. This value must fall between the minimum and maximum
8323
- # 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.
8324
8449
  #
8325
8450
  # @option params [Integer] :min_size
8326
8451
  # The minimum number of instances that are allowed in the specified
@@ -8332,7 +8457,7 @@ module Aws::GameLift
8332
8457
  #
8333
8458
  # @option params [String] :location
8334
8459
  # The name of a remote location to update fleet capacity settings for,
8335
- # in the form of an AWS Region code such as `us-west-2`.
8460
+ # in the form of an Amazon Web Services Region code such as `us-west-2`.
8336
8461
  #
8337
8462
  # @return [Types::UpdateFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8338
8463
  #
@@ -8587,24 +8712,24 @@ module Aws::GameLift
8587
8712
  #
8588
8713
  # @option params [String] :role_arn
8589
8714
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
8590
- # GameLift to access your EC2 Auto Scaling groups.
8715
+ # Web Services to access your Amazon EC2 Auto Scaling groups.
8591
8716
  #
8592
8717
  #
8593
8718
  #
8594
8719
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
8595
8720
  #
8596
8721
  # @option params [Array<Types::InstanceDefinition>] :instance_definitions
8597
- # An updated list of EC2 instance types to use in the Auto Scaling
8598
- # group. The instance definitions must specify at least two different
8599
- # instance types that are supported by GameLift FleetIQ. This updated
8600
- # list replaces the entire current list of instance definitions for the
8601
- # game server group. For more information on instance types, see [EC2
8602
- # Instance Types][1] in the *Amazon EC2 User Guide*. You can optionally
8603
- # specify capacity weighting for each instance type. If no weight value
8604
- # is specified for an instance type, it is set to the default value
8605
- # "1". For more information about capacity weighting, see [ Instance
8606
- # Weighting for Amazon EC2 Auto Scaling][2] in the Amazon EC2 Auto
8607
- # 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.
8608
8733
  #
8609
8734
  #
8610
8735
  #
@@ -8619,8 +8744,8 @@ module Aws::GameLift
8619
8744
  # instances cannot be terminated while there are active game servers
8620
8745
  # running except in the event of a forced game server group deletion
8621
8746
  # (see ). An exception to this is with Spot Instances, which can be
8622
- # terminated by AWS regardless of protection status. This property is
8623
- # 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.
8624
8749
  #
8625
8750
  # @option params [String] :balancing_strategy
8626
8751
  # Indicates how GameLift FleetIQ balances the use of Spot Instances and
@@ -8792,14 +8917,18 @@ module Aws::GameLift
8792
8917
  #
8793
8918
  # **Related actions**
8794
8919
  #
8795
- # CreateGameSessionQueue \| DescribeGameSessionQueues \|
8796
- # UpdateGameSessionQueue \| DeleteGameSessionQueue \| [All APIs by
8797
- # task][2]
8920
+ # [CreateGameSessionQueue][2] \| [DescribeGameSessionQueues][3] \|
8921
+ # [UpdateGameSessionQueue][4] \| [DeleteGameSessionQueue][5] \| [All
8922
+ # APIs by task][6]
8798
8923
  #
8799
8924
  #
8800
8925
  #
8801
8926
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
8802
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
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
8803
8932
  #
8804
8933
  # @option params [required, String] :name
8805
8934
  # A descriptive label that is associated with game session queue. Queue
@@ -8830,10 +8959,10 @@ module Aws::GameLift
8830
8959
  #
8831
8960
  # @option params [Types::FilterConfiguration] :filter_configuration
8832
8961
  # A list of locations where a queue is allowed to place new game
8833
- # sessions. Locations are specified in the form of AWS Region codes,
8834
- # such as `us-west-2`. If this parameter is not set, game sessions can
8835
- # be placed in any queue location. To remove an existing filter
8836
- # 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.
8837
8966
  #
8838
8967
  # @option params [Types::PriorityConfiguration] :priority_configuration
8839
8968
  # Custom settings to use when prioritizing destinations and locations
@@ -9208,13 +9337,13 @@ module Aws::GameLift
9208
9337
  # the *Version* parameter to track updates to the script.
9209
9338
  #
9210
9339
  # If the call is successful, the updated metadata is stored in the
9211
- # script record and a revised script is uploaded to the Amazon GameLift
9212
- # service. Once the script is updated and acquired by a fleet instance,
9213
- # 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.
9214
9343
  #
9215
9344
  # **Learn more**
9216
9345
  #
9217
- # [Amazon GameLift Realtime Servers][1]
9346
+ # [Amazon Web Services Realtime Servers][1]
9218
9347
  #
9219
9348
  # **Related actions**
9220
9349
  #
@@ -9242,21 +9371,22 @@ module Aws::GameLift
9242
9371
  # The location of the Amazon S3 bucket where a zipped file containing
9243
9372
  # your Realtime scripts is stored. The storage location must specify the
9244
9373
  # Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
9245
- # that allows Amazon GameLift to access the Amazon S3 storage location.
9246
- # The S3 bucket must be in the same Region where you want to create a
9247
- # new script. By default, Amazon GameLift uploads the latest version of
9248
- # the zip file; if you have S3 object versioning turned on, you can use
9249
- # the `ObjectVersion` parameter to specify an earlier version.
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.
9250
9380
  #
9251
9381
  # @option params [String, StringIO, File] :zip_file
9252
9382
  # A data object containing your Realtime scripts and dependencies as a
9253
9383
  # zip file. The zip file can have one or multiple files. Maximum size of
9254
9384
  # a zip file is 5 MB.
9255
9385
  #
9256
- # When using the AWS CLI tool to create a script, this parameter is set
9257
- # to the zip file name. It must be prepended with the string
9258
- # "fileb://" to indicate that the file data is a binary object. For
9259
- # 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`.
9260
9390
  #
9261
9391
  # @return [Types::UpdateScriptOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9262
9392
  #
@@ -9363,7 +9493,7 @@ module Aws::GameLift
9363
9493
  params: params,
9364
9494
  config: config)
9365
9495
  context[:gem_name] = 'aws-sdk-gamelift'
9366
- context[:gem_version] = '1.50.0'
9496
+ context[:gem_version] = '1.54.0'
9367
9497
  Seahorse::Client::Request.new(handlers, context)
9368
9498
  end
9369
9499