aws-sdk-gamelift 1.0.0.rc12 → 1.0.0.rc13

Sign up to get free protection for your applications and to get access to all the features.
@@ -8,6 +8,44 @@
8
8
  module Aws::GameLift
9
9
  module Types
10
10
 
11
+ # Represents the input for a request action.
12
+ #
13
+ # @note When making an API call, you may pass AcceptMatchInput
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # ticket_id: "MatchmakingIdStringModel", # required
18
+ # player_ids: ["PlayerIdStringModel"], # required
19
+ # acceptance_type: "ACCEPT", # required, accepts ACCEPT, REJECT
20
+ # }
21
+ #
22
+ # @!attribute [rw] ticket_id
23
+ # Unique identifier for a matchmaking ticket. The ticket must be in
24
+ # status `REQUIRES_ACCEPTANCE`; otherwise this request will fail.
25
+ # @return [String]
26
+ #
27
+ # @!attribute [rw] player_ids
28
+ # Unique identifier for a player delivering the response. This
29
+ # parameter can include one or multiple player IDs.
30
+ # @return [Array<String>]
31
+ #
32
+ # @!attribute [rw] acceptance_type
33
+ # Player response to the proposed match.
34
+ # @return [String]
35
+ #
36
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AcceptMatchInput AWS API Documentation
37
+ #
38
+ class AcceptMatchInput < Struct.new(
39
+ :ticket_id,
40
+ :player_ids,
41
+ :acceptance_type)
42
+ include Aws::Structure
43
+ end
44
+
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AcceptMatchOutput AWS API Documentation
46
+ #
47
+ class AcceptMatchOutput < Aws::EmptyStructure; end
48
+
11
49
  # Properties describing a fleet alias.
12
50
  #
13
51
  # Alias-related operations include:
@@ -73,21 +111,70 @@ module Aws::GameLift
73
111
  include Aws::Structure
74
112
  end
75
113
 
76
- # AWS access credentials sometimes used for uploading game build files
77
- # to Amazon GameLift. They are valid for a limited time. If they expire
114
+ # Values for use in Player attribute type:value pairs. This object lets
115
+ # you specify an attribute value using any of the valid data types:
116
+ # string, number, string array or data map. Each `AttributeValue` object
117
+ # can use only one of the available properties.
118
+ #
119
+ # @note When making an API call, you may pass AttributeValue
120
+ # data as a hash:
121
+ #
122
+ # {
123
+ # s: "NonZeroAndMaxString",
124
+ # n: 1.0,
125
+ # sl: ["NonZeroAndMaxString"],
126
+ # sdm: {
127
+ # "NonZeroAndMaxString" => 1.0,
128
+ # },
129
+ # }
130
+ #
131
+ # @!attribute [rw] s
132
+ # For single string values. Maximum string length is 100 characters.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] n
136
+ # For number values, expressed as double.
137
+ # @return [Float]
138
+ #
139
+ # @!attribute [rw] sl
140
+ # For a list of up to 10 strings. Maximum length for each string is
141
+ # 100 characters. Duplicate values are not recognized; all occurances
142
+ # of the the repeated value after the first of a repeated value are
143
+ # ignored.
144
+ # @return [Array<String>]
145
+ #
146
+ # @!attribute [rw] sdm
147
+ # For a map of up to 10 type:value pairs. Maximum length for each
148
+ # string value is 100 characters.
149
+ # @return [Hash<String,Float>]
150
+ #
151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AttributeValue AWS API Documentation
152
+ #
153
+ class AttributeValue < Struct.new(
154
+ :s,
155
+ :n,
156
+ :sl,
157
+ :sdm)
158
+ include Aws::Structure
159
+ end
160
+
161
+ # Temporary access credentials used for uploading game build files to
162
+ # Amazon GameLift. They are valid for a limited time. If they expire
78
163
  # before you upload your game build, get a new set by calling
79
164
  # RequestUploadCredentials.
80
165
  #
81
166
  # @!attribute [rw] access_key_id
82
- # Access key for an AWS account.
167
+ # Temporary key allowing access to the Amazon GameLift S3 account.
83
168
  # @return [String]
84
169
  #
85
170
  # @!attribute [rw] secret_access_key
86
- # Secret key for an AWS account.
171
+ # Temporary secret key allowing access to the Amazon GameLift S3
172
+ # account.
87
173
  # @return [String]
88
174
  #
89
175
  # @!attribute [rw] session_token
90
- # Token specific to a build ID.
176
+ # Token used to associate a specific build ID with the files uploaded
177
+ # using these credentials.
91
178
  # @return [String]
92
179
  #
93
180
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/AwsCredentials AWS API Documentation
@@ -505,6 +592,7 @@ module Aws::GameLift
505
592
  # creator_id: "NonZeroAndMaxString",
506
593
  # game_session_id: "IdStringModel",
507
594
  # idempotency_token: "IdStringModel",
595
+ # game_session_data: "GameSessionData",
508
596
  # }
509
597
  #
510
598
  # @!attribute [rw] fleet_id
@@ -529,9 +617,14 @@ module Aws::GameLift
529
617
  # @return [String]
530
618
  #
531
619
  # @!attribute [rw] game_properties
532
- # Set of developer-defined properties for a game session. These
533
- # properties are passed to the server process hosting the game
534
- # session.
620
+ # Set of developer-defined properties for a game session, formatted as
621
+ # a set of type:value pairs. These properties are included in the
622
+ # GameSession object, which is passed to the game server with a
623
+ # request to start a new game session (see [Start a Game Session][1]).
624
+ #
625
+ #
626
+ #
627
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
535
628
  # @return [Array<Types::GameProperty>]
536
629
  #
537
630
  # @!attribute [rw] creator_id
@@ -557,7 +650,20 @@ module Aws::GameLift
557
650
  # string is included in the new game session's ID. (A game session ID
558
651
  # has the following format:
559
652
  # `arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string
560
- # or idempotency token>`.)
653
+ # or idempotency token>`.) Idempotency tokens remain in use for 30
654
+ # days after a game session has ended; game session objects are
655
+ # retained for this time period and then deleted.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] game_session_data
659
+ # Set of developer-defined game session properties, formatted as a
660
+ # single string value. This data is included in the GameSession
661
+ # object, which is passed to the game server with a request to start a
662
+ # new game session (see [Start a Game Session][1]).
663
+ #
664
+ #
665
+ #
666
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
561
667
  # @return [String]
562
668
  #
563
669
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSessionInput AWS API Documentation
@@ -570,7 +676,8 @@ module Aws::GameLift
570
676
  :game_properties,
571
677
  :creator_id,
572
678
  :game_session_id,
573
- :idempotency_token)
679
+ :idempotency_token,
680
+ :game_session_data)
574
681
  include Aws::Structure
575
682
  end
576
683
 
@@ -609,14 +716,14 @@ module Aws::GameLift
609
716
  # }
610
717
  #
611
718
  # @!attribute [rw] name
612
- # Descriptive label that is associated with queue. Queue names must be
613
- # unique within each region.
719
+ # Descriptive label that is associated with game session queue. Queue
720
+ # names must be unique within each region.
614
721
  # @return [String]
615
722
  #
616
723
  # @!attribute [rw] timeout_in_seconds
617
724
  # Maximum time, in seconds, that a new game session placement request
618
725
  # remains in the queue. When a request exceeds this time, the game
619
- # session placement changes to a TIMED\_OUT status.
726
+ # session placement changes to a `TIMED_OUT` status.
620
727
  # @return [Integer]
621
728
  #
622
729
  # @!attribute [rw] player_latency_policies
@@ -664,6 +771,193 @@ module Aws::GameLift
664
771
  include Aws::Structure
665
772
  end
666
773
 
774
+ # Represents the input for a request action.
775
+ #
776
+ # @note When making an API call, you may pass CreateMatchmakingConfigurationInput
777
+ # data as a hash:
778
+ #
779
+ # {
780
+ # name: "MatchmakingIdStringModel", # required
781
+ # description: "NonZeroAndMaxString",
782
+ # game_session_queue_arns: ["ArnStringModel"], # required
783
+ # request_timeout_seconds: 1, # required
784
+ # acceptance_timeout_seconds: 1,
785
+ # acceptance_required: false, # required
786
+ # rule_set_name: "MatchmakingIdStringModel", # required
787
+ # notification_target: "SnsArnStringModel",
788
+ # additional_player_count: 1,
789
+ # custom_event_data: "CustomEventData",
790
+ # game_properties: [
791
+ # {
792
+ # key: "GamePropertyKey", # required
793
+ # value: "GamePropertyValue", # required
794
+ # },
795
+ # ],
796
+ # game_session_data: "GameSessionData",
797
+ # }
798
+ #
799
+ # @!attribute [rw] name
800
+ # Unique identifier for a matchmaking configuration. This name is used
801
+ # to identify the configuration associated with a matchmaking request
802
+ # or ticket.
803
+ # @return [String]
804
+ #
805
+ # @!attribute [rw] description
806
+ # Meaningful description of the matchmaking configuration.
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] game_session_queue_arns
810
+ # Amazon Resource Name ([ARN][1]) that is assigned to a game session
811
+ # queue and uniquely identifies it. Format is
812
+ # `arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
813
+ # These queues are used when placing game sessions for matches that
814
+ # are created with this matchmaking configuration. Queues can be
815
+ # located in any region.
816
+ #
817
+ #
818
+ #
819
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
820
+ # @return [Array<String>]
821
+ #
822
+ # @!attribute [rw] request_timeout_seconds
823
+ # Maximum duration, in seconds, that a matchmaking ticket can remain
824
+ # in process before timing out. Requests that time out can be
825
+ # resubmitted as needed.
826
+ # @return [Integer]
827
+ #
828
+ # @!attribute [rw] acceptance_timeout_seconds
829
+ # Length of time (in seconds) to wait for players to accept a proposed
830
+ # match. If any player rejects the match or fails to accept before the
831
+ # timeout, the ticket continues to look for an acceptable match.
832
+ # @return [Integer]
833
+ #
834
+ # @!attribute [rw] acceptance_required
835
+ # Flag that determines whether or not a match that was created with
836
+ # this configuration must be accepted by the matched players. To
837
+ # require acceptance, set to TRUE.
838
+ # @return [Boolean]
839
+ #
840
+ # @!attribute [rw] rule_set_name
841
+ # Unique identifier for a matchmaking rule set to use with this
842
+ # configuration. A matchmaking configuration can only use rule sets
843
+ # that are defined in the same region.
844
+ # @return [String]
845
+ #
846
+ # @!attribute [rw] notification_target
847
+ # SNS topic ARN that is set up to receive matchmaking notifications.
848
+ # @return [String]
849
+ #
850
+ # @!attribute [rw] additional_player_count
851
+ # Number of player slots in a match to keep open for future players.
852
+ # For example, if the configuration's rule set specifies a match for
853
+ # a single 12-person team, and the additional player count is set to
854
+ # 2, only 10 players are selected for the match.
855
+ # @return [Integer]
856
+ #
857
+ # @!attribute [rw] custom_event_data
858
+ # Information to attached to all events related to the matchmaking
859
+ # configuration.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] game_properties
863
+ # Set of developer-defined properties for a game session, formatted as
864
+ # a set of type:value pairs. These properties are included in the
865
+ # GameSession object, which is passed to the game server with a
866
+ # request to start a new game session (see [Start a Game Session][1]).
867
+ # This information is added to the new GameSession object that is
868
+ # created for a successful match.
869
+ #
870
+ #
871
+ #
872
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
873
+ # @return [Array<Types::GameProperty>]
874
+ #
875
+ # @!attribute [rw] game_session_data
876
+ # Set of developer-defined game session properties, formatted as a
877
+ # single string value. This data is included in the GameSession
878
+ # object, which is passed to the game server with a request to start a
879
+ # new game session (see [Start a Game Session][1]). This information
880
+ # is added to the new GameSession object that is created for a
881
+ # successful match.
882
+ #
883
+ #
884
+ #
885
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
886
+ # @return [String]
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfigurationInput AWS API Documentation
889
+ #
890
+ class CreateMatchmakingConfigurationInput < Struct.new(
891
+ :name,
892
+ :description,
893
+ :game_session_queue_arns,
894
+ :request_timeout_seconds,
895
+ :acceptance_timeout_seconds,
896
+ :acceptance_required,
897
+ :rule_set_name,
898
+ :notification_target,
899
+ :additional_player_count,
900
+ :custom_event_data,
901
+ :game_properties,
902
+ :game_session_data)
903
+ include Aws::Structure
904
+ end
905
+
906
+ # Represents the returned data in response to a request action.
907
+ #
908
+ # @!attribute [rw] configuration
909
+ # Object that describes the newly created matchmaking configuration.
910
+ # @return [Types::MatchmakingConfiguration]
911
+ #
912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfigurationOutput AWS API Documentation
913
+ #
914
+ class CreateMatchmakingConfigurationOutput < Struct.new(
915
+ :configuration)
916
+ include Aws::Structure
917
+ end
918
+
919
+ # Represents the input for a request action.
920
+ #
921
+ # @note When making an API call, you may pass CreateMatchmakingRuleSetInput
922
+ # data as a hash:
923
+ #
924
+ # {
925
+ # name: "MatchmakingIdStringModel", # required
926
+ # rule_set_body: "RuleSetBody", # required
927
+ # }
928
+ #
929
+ # @!attribute [rw] name
930
+ # Unique identifier for a matchmaking rule set. This name is used to
931
+ # identify the rule set associated with a matchmaking configuration.
932
+ # @return [String]
933
+ #
934
+ # @!attribute [rw] rule_set_body
935
+ # Collection of matchmaking rules, formatted as a JSON string. (Note
936
+ # that comments are not allowed in JSON, but most elements support a
937
+ # description field.)
938
+ # @return [String]
939
+ #
940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingRuleSetInput AWS API Documentation
941
+ #
942
+ class CreateMatchmakingRuleSetInput < Struct.new(
943
+ :name,
944
+ :rule_set_body)
945
+ include Aws::Structure
946
+ end
947
+
948
+ # Represents the returned data in response to a request action.
949
+ #
950
+ # @!attribute [rw] rule_set
951
+ # Object that describes the newly created matchmaking rule set.
952
+ # @return [Types::MatchmakingRuleSet]
953
+ #
954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingRuleSetOutput AWS API Documentation
955
+ #
956
+ class CreateMatchmakingRuleSetOutput < Struct.new(
957
+ :rule_set)
958
+ include Aws::Structure
959
+ end
960
+
667
961
  # Represents the input for a request action.
668
962
  #
669
963
  # @note When making an API call, you may pass CreatePlayerSessionInput
@@ -833,8 +1127,8 @@ module Aws::GameLift
833
1127
  # }
834
1128
  #
835
1129
  # @!attribute [rw] name
836
- # Descriptive label that is associated with queue. Queue names must be
837
- # unique within each region.
1130
+ # Descriptive label that is associated with game session queue. Queue
1131
+ # names must be unique within each region.
838
1132
  # @return [String]
839
1133
  #
840
1134
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameSessionQueueInput AWS API Documentation
@@ -848,6 +1142,30 @@ module Aws::GameLift
848
1142
  #
849
1143
  class DeleteGameSessionQueueOutput < Aws::EmptyStructure; end
850
1144
 
1145
+ # Represents the input for a request action.
1146
+ #
1147
+ # @note When making an API call, you may pass DeleteMatchmakingConfigurationInput
1148
+ # data as a hash:
1149
+ #
1150
+ # {
1151
+ # name: "MatchmakingIdStringModel", # required
1152
+ # }
1153
+ #
1154
+ # @!attribute [rw] name
1155
+ # Unique identifier for a matchmaking configuration
1156
+ # @return [String]
1157
+ #
1158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingConfigurationInput AWS API Documentation
1159
+ #
1160
+ class DeleteMatchmakingConfigurationInput < Struct.new(
1161
+ :name)
1162
+ include Aws::Structure
1163
+ end
1164
+
1165
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteMatchmakingConfigurationOutput AWS API Documentation
1166
+ #
1167
+ class DeleteMatchmakingConfigurationOutput < Aws::EmptyStructure; end
1168
+
851
1169
  # Represents the input for a request action.
852
1170
  #
853
1171
  # @note When making an API call, you may pass DeleteScalingPolicyInput
@@ -1012,9 +1330,9 @@ module Aws::GameLift
1012
1330
  # @!attribute [rw] next_token
1013
1331
  # Token that indicates the start of the next sequential page of
1014
1332
  # results. Use the token that is returned with a previous call to this
1015
- # action. To specify the start of the result set, do not specify a
1016
- # value. This parameter is ignored when the request specifies one or a
1017
- # list of fleet IDs.
1333
+ # action. To start at the beginning of the result set, do not specify
1334
+ # a value. This parameter is ignored when the request specifies one or
1335
+ # a list of fleet IDs.
1018
1336
  # @return [String]
1019
1337
  #
1020
1338
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetAttributesInput AWS API Documentation
@@ -1074,9 +1392,9 @@ module Aws::GameLift
1074
1392
  # @!attribute [rw] next_token
1075
1393
  # Token that indicates the start of the next sequential page of
1076
1394
  # results. Use the token that is returned with a previous call to this
1077
- # action. To specify the start of the result set, do not specify a
1078
- # value. This parameter is ignored when the request specifies one or a
1079
- # list of fleet IDs.
1395
+ # action. To start at the beginning of the result set, do not specify
1396
+ # a value. This parameter is ignored when the request specifies one or
1397
+ # a list of fleet IDs.
1080
1398
  # @return [String]
1081
1399
  #
1082
1400
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetCapacityInput AWS API Documentation
@@ -1149,8 +1467,8 @@ module Aws::GameLift
1149
1467
  # @!attribute [rw] next_token
1150
1468
  # Token that indicates the start of the next sequential page of
1151
1469
  # results. Use the token that is returned with a previous call to this
1152
- # action. To specify the start of the result set, do not specify a
1153
- # value.
1470
+ # action. To start at the beginning of the result set, do not specify
1471
+ # a value.
1154
1472
  # @return [String]
1155
1473
  #
1156
1474
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetEventsInput AWS API Documentation
@@ -1245,9 +1563,9 @@ module Aws::GameLift
1245
1563
  # @!attribute [rw] next_token
1246
1564
  # Token that indicates the start of the next sequential page of
1247
1565
  # results. Use the token that is returned with a previous call to this
1248
- # action. To specify the start of the result set, do not specify a
1249
- # value. This parameter is ignored when the request specifies one or a
1250
- # list of fleet IDs.
1566
+ # action. To start at the beginning of the result set, do not specify
1567
+ # a value. This parameter is ignored when the request specifies one or
1568
+ # a list of fleet IDs.
1251
1569
  # @return [String]
1252
1570
  #
1253
1571
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetUtilizationInput AWS API Documentation
@@ -1322,8 +1640,8 @@ module Aws::GameLift
1322
1640
  # @!attribute [rw] next_token
1323
1641
  # Token that indicates the start of the next sequential page of
1324
1642
  # results. Use the token that is returned with a previous call to this
1325
- # action. To specify the start of the result set, do not specify a
1326
- # value.
1643
+ # action. To start at the beginning of the result set, do not specify
1644
+ # a value.
1327
1645
  # @return [String]
1328
1646
  #
1329
1647
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionDetailsInput AWS API Documentation
@@ -1417,8 +1735,8 @@ module Aws::GameLift
1417
1735
  # @!attribute [rw] next_token
1418
1736
  # Token that indicates the start of the next sequential page of
1419
1737
  # results. Use the token that is returned with a previous call to this
1420
- # action. To specify the start of the result set, do not specify a
1421
- # value.
1738
+ # action. To start at the beginning of the result set, do not specify
1739
+ # a value.
1422
1740
  # @return [String]
1423
1741
  #
1424
1742
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionQueuesInput AWS API Documentation
@@ -1493,8 +1811,8 @@ module Aws::GameLift
1493
1811
  # @!attribute [rw] next_token
1494
1812
  # Token that indicates the start of the next sequential page of
1495
1813
  # results. Use the token that is returned with a previous call to this
1496
- # action. To specify the start of the result set, do not specify a
1497
- # value.
1814
+ # action. To start at the beginning of the result set, do not specify
1815
+ # a value.
1498
1816
  # @return [String]
1499
1817
  #
1500
1818
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionsInput AWS API Documentation
@@ -1559,8 +1877,8 @@ module Aws::GameLift
1559
1877
  # @!attribute [rw] next_token
1560
1878
  # Token that indicates the start of the next sequential page of
1561
1879
  # results. Use the token that is returned with a previous call to this
1562
- # action. To specify the start of the result set, do not specify a
1563
- # value.
1880
+ # action. To start at the beginning of the result set, do not specify
1881
+ # a value.
1564
1882
  # @return [String]
1565
1883
  #
1566
1884
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeInstancesInput AWS API Documentation
@@ -1594,6 +1912,163 @@ module Aws::GameLift
1594
1912
  include Aws::Structure
1595
1913
  end
1596
1914
 
1915
+ # Represents the input for a request action.
1916
+ #
1917
+ # @note When making an API call, you may pass DescribeMatchmakingConfigurationsInput
1918
+ # data as a hash:
1919
+ #
1920
+ # {
1921
+ # names: ["MatchmakingIdStringModel"],
1922
+ # rule_set_name: "MatchmakingIdStringModel",
1923
+ # limit: 1,
1924
+ # next_token: "NonZeroAndMaxString",
1925
+ # }
1926
+ #
1927
+ # @!attribute [rw] names
1928
+ # Unique identifier for a matchmaking configuration(s) to retrieve. To
1929
+ # request all existing configurations, leave this parameter empty.
1930
+ # @return [Array<String>]
1931
+ #
1932
+ # @!attribute [rw] rule_set_name
1933
+ # Unique identifier for a matchmaking rule set. Use this parameter to
1934
+ # retrieve all matchmaking configurations that use this rule set.
1935
+ # @return [String]
1936
+ #
1937
+ # @!attribute [rw] limit
1938
+ # Maximum number of results to return. Use this parameter with
1939
+ # `NextToken` to get results as a set of sequential pages. This
1940
+ # parameter is limited to 10.
1941
+ # @return [Integer]
1942
+ #
1943
+ # @!attribute [rw] next_token
1944
+ # Token that indicates the start of the next sequential page of
1945
+ # results. Use the token that is returned with a previous call to this
1946
+ # action. To start at the beginning of the result set, do not specify
1947
+ # a value.
1948
+ # @return [String]
1949
+ #
1950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingConfigurationsInput AWS API Documentation
1951
+ #
1952
+ class DescribeMatchmakingConfigurationsInput < Struct.new(
1953
+ :names,
1954
+ :rule_set_name,
1955
+ :limit,
1956
+ :next_token)
1957
+ include Aws::Structure
1958
+ end
1959
+
1960
+ # Represents the returned data in response to a request action.
1961
+ #
1962
+ # @!attribute [rw] configurations
1963
+ # Collection of requested matchmaking configuration objects.
1964
+ # @return [Array<Types::MatchmakingConfiguration>]
1965
+ #
1966
+ # @!attribute [rw] next_token
1967
+ # Token that indicates where to resume retrieving results on the next
1968
+ # call to this action. If no token is returned, these results
1969
+ # represent the end of the list.
1970
+ # @return [String]
1971
+ #
1972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingConfigurationsOutput AWS API Documentation
1973
+ #
1974
+ class DescribeMatchmakingConfigurationsOutput < Struct.new(
1975
+ :configurations,
1976
+ :next_token)
1977
+ include Aws::Structure
1978
+ end
1979
+
1980
+ # Represents the input for a request action.
1981
+ #
1982
+ # @note When making an API call, you may pass DescribeMatchmakingInput
1983
+ # data as a hash:
1984
+ #
1985
+ # {
1986
+ # ticket_ids: ["MatchmakingIdStringModel"], # required
1987
+ # }
1988
+ #
1989
+ # @!attribute [rw] ticket_ids
1990
+ # Unique identifier for a matchmaking ticket. To request all existing
1991
+ # tickets, leave this parameter empty.
1992
+ # @return [Array<String>]
1993
+ #
1994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingInput AWS API Documentation
1995
+ #
1996
+ class DescribeMatchmakingInput < Struct.new(
1997
+ :ticket_ids)
1998
+ include Aws::Structure
1999
+ end
2000
+
2001
+ # Represents the returned data in response to a request action.
2002
+ #
2003
+ # @!attribute [rw] ticket_list
2004
+ # Collection of existing matchmaking ticket objects matching the
2005
+ # request.
2006
+ # @return [Array<Types::MatchmakingTicket>]
2007
+ #
2008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingOutput AWS API Documentation
2009
+ #
2010
+ class DescribeMatchmakingOutput < Struct.new(
2011
+ :ticket_list)
2012
+ include Aws::Structure
2013
+ end
2014
+
2015
+ # Represents the input for a request action.
2016
+ #
2017
+ # @note When making an API call, you may pass DescribeMatchmakingRuleSetsInput
2018
+ # data as a hash:
2019
+ #
2020
+ # {
2021
+ # names: ["MatchmakingIdStringModel"],
2022
+ # limit: 1,
2023
+ # next_token: "NonZeroAndMaxString",
2024
+ # }
2025
+ #
2026
+ # @!attribute [rw] names
2027
+ # Unique identifier for a matchmaking rule set. This name is used to
2028
+ # identify the rule set associated with a matchmaking configuration.
2029
+ # @return [Array<String>]
2030
+ #
2031
+ # @!attribute [rw] limit
2032
+ # Maximum number of results to return. Use this parameter with
2033
+ # `NextToken` to get results as a set of sequential pages.
2034
+ # @return [Integer]
2035
+ #
2036
+ # @!attribute [rw] next_token
2037
+ # Token that indicates the start of the next sequential page of
2038
+ # results. Use the token that is returned with a previous call to this
2039
+ # action. To start at the beginning of the result set, do not specify
2040
+ # a value.
2041
+ # @return [String]
2042
+ #
2043
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingRuleSetsInput AWS API Documentation
2044
+ #
2045
+ class DescribeMatchmakingRuleSetsInput < Struct.new(
2046
+ :names,
2047
+ :limit,
2048
+ :next_token)
2049
+ include Aws::Structure
2050
+ end
2051
+
2052
+ # Represents the returned data in response to a request action.
2053
+ #
2054
+ # @!attribute [rw] rule_sets
2055
+ # Collection of requested matchmaking rule set objects.
2056
+ # @return [Array<Types::MatchmakingRuleSet>]
2057
+ #
2058
+ # @!attribute [rw] next_token
2059
+ # Token that indicates where to resume retrieving results on the next
2060
+ # call to this action. If no token is returned, these results
2061
+ # represent the end of the list.
2062
+ # @return [String]
2063
+ #
2064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingRuleSetsOutput AWS API Documentation
2065
+ #
2066
+ class DescribeMatchmakingRuleSetsOutput < Struct.new(
2067
+ :rule_sets,
2068
+ :next_token)
2069
+ include Aws::Structure
2070
+ end
2071
+
1597
2072
  # Represents the input for a request action.
1598
2073
  #
1599
2074
  # @note When making an API call, you may pass DescribePlayerSessionsInput
@@ -1649,8 +2124,8 @@ module Aws::GameLift
1649
2124
  # @!attribute [rw] next_token
1650
2125
  # Token that indicates the start of the next sequential page of
1651
2126
  # results. Use the token that is returned with a previous call to this
1652
- # action. To specify the start of the result set, do not specify a
1653
- # value. If a player session ID is specified, this parameter is
2127
+ # action. To start at the beginning of the result set, do not specify
2128
+ # a value. If a player session ID is specified, this parameter is
1654
2129
  # ignored.
1655
2130
  # @return [String]
1656
2131
  #
@@ -1767,8 +2242,8 @@ module Aws::GameLift
1767
2242
  # @!attribute [rw] next_token
1768
2243
  # Token that indicates the start of the next sequential page of
1769
2244
  # results. Use the token that is returned with a previous call to this
1770
- # action. To specify the start of the result set, do not specify a
1771
- # value.
2245
+ # action. To start at the beginning of the result set, do not specify
2246
+ # a value.
1772
2247
  # @return [String]
1773
2248
  #
1774
2249
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeScalingPoliciesInput AWS API Documentation
@@ -1986,11 +2461,11 @@ module Aws::GameLift
1986
2461
  # * Fleet creation events:
1987
2462
  #
1988
2463
  # * **FLEET\_CREATED** – A fleet record was successfully created
1989
- # with a status of NEW. Event messaging includes the fleet ID.
2464
+ # with a status of `NEW`. Event messaging includes the fleet ID.
1990
2465
  #
1991
- # * **FLEET\_STATE\_DOWNLOADING** – Fleet status changed from NEW to
1992
- # DOWNLOADING. The compressed build has started downloading to a
1993
- # fleet instance for installation.
2466
+ # * **FLEET\_STATE\_DOWNLOADING** – Fleet status changed from `NEW`
2467
+ # to `DOWNLOADING`. The compressed build has started downloading
2468
+ # to a fleet instance for installation.
1994
2469
  #
1995
2470
  # * **FLEET\_BINARY\_DOWNLOAD\_FAILED** – The build failed to
1996
2471
  # download to the fleet instance.
@@ -1999,47 +2474,45 @@ module Aws::GameLift
1999
2474
  # was successfully downloaded to an instance, and the build files
2000
2475
  # are now being extracted from the uploaded build and saved to an
2001
2476
  # instance. Failure at this stage prevents a fleet from moving to
2002
- # ACTIVE status. Logs for this stage display a list of the files
2477
+ # `ACTIVE` status. Logs for this stage display a list of the files
2003
2478
  # that are extracted and saved on the instance. Access the logs by
2004
- # using the URL in *PreSignedLogUrl*).
2479
+ # using the URL in *PreSignedLogUrl*.
2005
2480
  #
2006
2481
  # * **FLEET\_CREATION\_RUNNING\_INSTALLER** – The game server build
2007
2482
  # files were successfully extracted, and the Amazon GameLift is
2008
2483
  # now running the build's install script (if one is included).
2009
- # Failure in this stage prevents a fleet from moving to ACTIVE
2484
+ # Failure in this stage prevents a fleet from moving to `ACTIVE`
2010
2485
  # status. Logs for this stage list the installation steps and
2011
- # whether or not the install completed sucessfully. Access the
2012
- # logs by using the URL in *PreSignedLogUrl*).
2486
+ # whether or not the install completed successfully. Access the
2487
+ # logs by using the URL in *PreSignedLogUrl*.
2013
2488
  #
2014
2489
  # * **FLEET\_CREATION\_VALIDATING\_RUNTIME\_CONFIG** – The build
2015
2490
  # process was successful, and the Amazon GameLift is now verifying
2016
- # that the game server launch path(s), which are specified in the
2491
+ # that the game server launch paths, which are specified in the
2017
2492
  # fleet's run-time configuration, exist. If any listed launch
2018
2493
  # path exists, Amazon GameLift tries to launch a game server
2019
2494
  # process and waits for the process to report ready. Failures in
2020
- # this stage prevent a fleet from moving to ACTIVE status. Logs
2495
+ # this stage prevent a fleet from moving to `ACTIVE` status. Logs
2021
2496
  # for this stage list the launch paths in the run-time
2022
2497
  # configuration and indicate whether each is found. Access the
2023
- # logs by using the URL in *PreSignedLogUrl*). Once the game
2024
- # server is launched, failures and crashes are logged; these logs
2025
- # can be downloaded from the Amazon GameLift console.
2498
+ # logs by using the URL in *PreSignedLogUrl*.
2026
2499
  #
2027
2500
  # * **FLEET\_STATE\_VALIDATING** – Fleet status changed from
2028
- # DOWNLOADING to VALIDATING.
2501
+ # `DOWNLOADING` to `VALIDATING`.
2029
2502
  #
2030
2503
  # * **FLEET\_VALIDATION\_LAUNCH\_PATH\_NOT\_FOUND** – Validation of
2031
- # the run-time validation failed because the executable specified
2032
- # in a launch path does not exist on the instance.
2504
+ # the run-time configuration failed because the executable
2505
+ # specified in a launch path does not exist on the instance.
2033
2506
  #
2034
2507
  # * **FLEET\_STATE\_BUILDING** – Fleet status changed from
2035
- # VALIDATING to BUILDING.
2508
+ # `VALIDATING` to `BUILDING`.
2036
2509
  #
2037
2510
  # * **FLEET\_VALIDATION\_EXECUTABLE\_RUNTIME\_FAILURE** – Validation
2038
- # of the runtime validation failed because the executable
2511
+ # of the run-time configuration failed because the executable
2039
2512
  # specified in a launch path failed to run on the fleet instance.
2040
2513
  #
2041
2514
  # * **FLEET\_STATE\_ACTIVATING** – Fleet status changed from
2042
- # BUILDING to ACTIVATING.
2515
+ # `BUILDING` to `ACTIVATING`.
2043
2516
  #
2044
2517
  # * **FLEET\_ACTIVATION\_FAILED** - The fleet failed to successfully
2045
2518
  # complete one of the steps in the fleet activation process. This
@@ -2050,7 +2523,7 @@ module Aws::GameLift
2050
2523
  # ready" to the Amazon GameLift service.
2051
2524
  #
2052
2525
  # * **FLEET\_STATE\_ACTIVE** – The fleet's status changed from
2053
- # ACTIVATING to ACTIVE. The fleet is now ready to host game
2526
+ # `ACTIVATING` to `ACTIVE`. The fleet is now ready to host game
2054
2527
  # sessions.
2055
2528
  #
2056
2529
  # * Other fleet events:
@@ -2078,10 +2551,10 @@ module Aws::GameLift
2078
2551
  # @return [Time]
2079
2552
  #
2080
2553
  # @!attribute [rw] pre_signed_log_url
2081
- # Location of stored logs with additional detail related to the event,
2082
- # useful for debugging issues. The URL is valid for 15 minutes. Fleet
2083
- # creation logs can also be accessed through the Amazon GameLift
2084
- # console.
2554
+ # Location of stored logs with additional detail that is related to
2555
+ # the event. This is useful for debugging issues. The URL is valid for
2556
+ # 15 minutes. You can also access fleet creation logs through the
2557
+ # Amazon GameLift console.
2085
2558
  # @return [String]
2086
2559
  #
2087
2560
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Event AWS API Documentation
@@ -2437,14 +2910,17 @@ module Aws::GameLift
2437
2910
  include Aws::Structure
2438
2911
  end
2439
2912
 
2440
- # Set of key-value pairs containing information a server process
2441
- # requires to set up a game session. This object allows you to pass in
2442
- # any set of data needed for your game. For more information, see the
2443
- # [Amazon GameLift Developer Guide][1].
2913
+ # Set of key-value pairs that contain information about a game session.
2914
+ # When included in a game session request, these properties communicate
2915
+ # details to be used when setting up the new game session, such as to
2916
+ # specify a game mode, level, or map. Game properties are passed to the
2917
+ # game server process when initiating a new game session; the server
2918
+ # process uses the properties as appropriate. For more information, see
2919
+ # the [ Amazon GameLift Developer Guide][1].
2444
2920
  #
2445
2921
  #
2446
2922
  #
2447
- # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/
2923
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create
2448
2924
  #
2449
2925
  # @note When making an API call, you may pass GameProperty
2450
2926
  # data as a hash:
@@ -2455,11 +2931,11 @@ module Aws::GameLift
2455
2931
  # }
2456
2932
  #
2457
2933
  # @!attribute [rw] key
2458
- # TBD
2934
+ # Game property identifier.
2459
2935
  # @return [String]
2460
2936
  #
2461
2937
  # @!attribute [rw] value
2462
- # TBD
2938
+ # Game property value.
2463
2939
  # @return [String]
2464
2940
  #
2465
2941
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameProperty AWS API Documentation
@@ -2472,6 +2948,13 @@ module Aws::GameLift
2472
2948
 
2473
2949
  # Properties describing a game session.
2474
2950
  #
2951
+ # A game session in ACTIVE status can host players. When a game session
2952
+ # ends, its status is set to `TERMINATED`.
2953
+ #
2954
+ # Once the session ends, the game session object is retained for 30
2955
+ # days. This means you can reuse idempotency token values after this
2956
+ # time. Game session logs are retained for 14 days.
2957
+ #
2475
2958
  # Game-session-related operations include:
2476
2959
  #
2477
2960
  # * CreateGameSession
@@ -2536,9 +3019,14 @@ module Aws::GameLift
2536
3019
  # @return [String]
2537
3020
  #
2538
3021
  # @!attribute [rw] game_properties
2539
- # Set of developer-defined properties for a game session. These
2540
- # properties are passed to the server process hosting the game
2541
- # session.
3022
+ # Set of developer-defined properties for a game session, formatted as
3023
+ # a set of type:value pairs. These properties are included in the
3024
+ # GameSession object, which is passed to the game server with a
3025
+ # request to start a new game session (see [Start a Game Session][1]).
3026
+ #
3027
+ #
3028
+ #
3029
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
2542
3030
  # @return [Array<Types::GameProperty>]
2543
3031
  #
2544
3032
  # @!attribute [rw] ip_address
@@ -2561,6 +3049,17 @@ module Aws::GameLift
2561
3049
  # of game sessions a player can create.
2562
3050
  # @return [String]
2563
3051
  #
3052
+ # @!attribute [rw] game_session_data
3053
+ # Set of developer-defined game session properties, formatted as a
3054
+ # single string value. This data is included in the GameSession
3055
+ # object, which is passed to the game server with a request to start a
3056
+ # new game session (see [Start a Game Session][1]).
3057
+ #
3058
+ #
3059
+ #
3060
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
3061
+ # @return [String]
3062
+ #
2564
3063
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSession AWS API Documentation
2565
3064
  #
2566
3065
  class GameSession < Struct.new(
@@ -2576,7 +3075,50 @@ module Aws::GameLift
2576
3075
  :ip_address,
2577
3076
  :port,
2578
3077
  :player_session_creation_policy,
2579
- :creator_id)
3078
+ :creator_id,
3079
+ :game_session_data)
3080
+ include Aws::Structure
3081
+ end
3082
+
3083
+ # Connection information for the new game session that is created with
3084
+ # matchmaking. (with StartMatchmaking). Once a match is set, the
3085
+ # FlexMatch engine places the match and creates a new game session for
3086
+ # it. This information, including the game session endpoint and player
3087
+ # sessions for each player in the original matchmaking request, is added
3088
+ # to the MatchmakingTicket, which can be retrieved by calling
3089
+ # DescribeMatchmaking.
3090
+ #
3091
+ # @!attribute [rw] game_session_arn
3092
+ # Amazon Resource Name ([ARN][1]) that is assigned to a game session
3093
+ # and uniquely identifies it.
3094
+ #
3095
+ #
3096
+ #
3097
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
3098
+ # @return [String]
3099
+ #
3100
+ # @!attribute [rw] ip_address
3101
+ # IP address of the game session. To connect to a Amazon GameLift game
3102
+ # server, an app needs both the IP address and port number.
3103
+ # @return [String]
3104
+ #
3105
+ # @!attribute [rw] port
3106
+ # Port number for the game session. To connect to a Amazon GameLift
3107
+ # game server, an app needs both the IP address and port number.
3108
+ # @return [Integer]
3109
+ #
3110
+ # @!attribute [rw] matched_player_sessions
3111
+ # Collection of player session IDs, one for each player ID that was
3112
+ # included in the original matchmaking request.
3113
+ # @return [Array<Types::MatchedPlayerSession>]
3114
+ #
3115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionConnectionInfo AWS API Documentation
3116
+ #
3117
+ class GameSessionConnectionInfo < Struct.new(
3118
+ :game_session_arn,
3119
+ :ip_address,
3120
+ :port,
3121
+ :matched_player_sessions)
2580
3122
  include Aws::Structure
2581
3123
  end
2582
3124
 
@@ -2622,8 +3164,8 @@ module Aws::GameLift
2622
3164
  # @return [String]
2623
3165
  #
2624
3166
  # @!attribute [rw] game_session_queue_name
2625
- # Descriptive label that is associated with queue. Queue names must be
2626
- # unique within each region.
3167
+ # Descriptive label that is associated with game session queue. Queue
3168
+ # names must be unique within each region.
2627
3169
  # @return [String]
2628
3170
  #
2629
3171
  # @!attribute [rw] status
@@ -2645,9 +3187,14 @@ module Aws::GameLift
2645
3187
  # @return [String]
2646
3188
  #
2647
3189
  # @!attribute [rw] game_properties
2648
- # Set of developer-defined properties for a game session. These
2649
- # properties are passed to the server process hosting the game
2650
- # session.
3190
+ # Set of developer-defined properties for a game session, formatted as
3191
+ # a set of type:value pairs. These properties are included in the
3192
+ # GameSession object, which is passed to the game server with a
3193
+ # request to start a new game session (see [Start a Game Session][1]).
3194
+ #
3195
+ #
3196
+ #
3197
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
2651
3198
  # @return [Array<Types::GameProperty>]
2652
3199
  #
2653
3200
  # @!attribute [rw] maximum_player_session_count
@@ -2662,25 +3209,26 @@ module Aws::GameLift
2662
3209
  #
2663
3210
  # @!attribute [rw] game_session_id
2664
3211
  # Unique identifier for the game session. This value is set once the
2665
- # new game session is placed (placement status is Fulfilled).
3212
+ # new game session is placed (placement status is `FULFILLED`).
2666
3213
  # @return [String]
2667
3214
  #
2668
3215
  # @!attribute [rw] game_session_arn
2669
3216
  # Identifier for the game session created by this placement request.
2670
3217
  # This value is set once the new game session is placed (placement
2671
- # status is Fulfilled). This identifier is unique across all regions.
2672
- # You can use this value as a `GameSessionId` value as needed.
3218
+ # status is `FULFILLED`). This identifier is unique across all
3219
+ # regions. You can use this value as a `GameSessionId` value as
3220
+ # needed.
2673
3221
  # @return [String]
2674
3222
  #
2675
3223
  # @!attribute [rw] game_session_region
2676
3224
  # Name of the region where the game session created by this placement
2677
3225
  # request is running. This value is set once the new game session is
2678
- # placed (placement status is Fulfilled).
3226
+ # placed (placement status is `FULFILLED`).
2679
3227
  # @return [String]
2680
3228
  #
2681
3229
  # @!attribute [rw] player_latencies
2682
3230
  # Set of values, expressed in milliseconds, indicating the amount of
2683
- # latency that players are experiencing when connected to AWS regions.
3231
+ # latency that a player experiences when connected to AWS regions.
2684
3232
  # @return [Array<Types::PlayerLatency>]
2685
3233
  #
2686
3234
  # @!attribute [rw] start_time
@@ -2698,26 +3246,37 @@ module Aws::GameLift
2698
3246
  # IP address of the game session. To connect to a Amazon GameLift game
2699
3247
  # server, an app needs both the IP address and port number. This value
2700
3248
  # is set once the new game session is placed (placement status is
2701
- # Fulfilled).
3249
+ # `FULFILLED`).
2702
3250
  # @return [String]
2703
3251
  #
2704
3252
  # @!attribute [rw] port
2705
3253
  # Port number for the game session. To connect to a Amazon GameLift
2706
3254
  # game server, an app needs both the IP address and port number. This
2707
3255
  # value is set once the new game session is placed (placement status
2708
- # is Fulfilled).
3256
+ # is `FULFILLED`).
2709
3257
  # @return [Integer]
2710
3258
  #
2711
3259
  # @!attribute [rw] placed_player_sessions
2712
3260
  # Collection of information on player sessions created in response to
2713
3261
  # the game session placement request. These player sessions are
2714
3262
  # created only once a new game session is successfully placed
2715
- # (placement status is Fulfilled). This information includes the
3263
+ # (placement status is `FULFILLED`). This information includes the
2716
3264
  # player ID (as provided in the placement request) and the
2717
3265
  # corresponding player session ID. Retrieve full player sessions by
2718
3266
  # calling DescribePlayerSessions with the player session ID.
2719
3267
  # @return [Array<Types::PlacedPlayerSession>]
2720
3268
  #
3269
+ # @!attribute [rw] game_session_data
3270
+ # Set of developer-defined game session properties, formatted as a
3271
+ # single string value. This data is included in the GameSession
3272
+ # object, which is passed to the game server with a request to start a
3273
+ # new game session (see [Start a Game Session][1]).
3274
+ #
3275
+ #
3276
+ #
3277
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
3278
+ # @return [String]
3279
+ #
2721
3280
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionPlacement AWS API Documentation
2722
3281
  #
2723
3282
  class GameSessionPlacement < Struct.new(
@@ -2735,7 +3294,8 @@ module Aws::GameLift
2735
3294
  :end_time,
2736
3295
  :ip_address,
2737
3296
  :port,
2738
- :placed_player_sessions)
3297
+ :placed_player_sessions,
3298
+ :game_session_data)
2739
3299
  include Aws::Structure
2740
3300
  end
2741
3301
 
@@ -2743,17 +3303,6 @@ module Aws::GameLift
2743
3303
  # placement requests. The queue configuration identifies several game
2744
3304
  # features:
2745
3305
  #
2746
- # Queue-related operations include:
2747
- #
2748
- # * CreateGameSessionQueue
2749
- #
2750
- # * DescribeGameSessionQueues
2751
- #
2752
- # * UpdateGameSessionQueue
2753
- #
2754
- # * DeleteGameSessionQueue
2755
- # ^
2756
- #
2757
3306
  # * The destinations where a new game session can potentially be hosted.
2758
3307
  # Amazon GameLift tries these destinations in an order based on either
2759
3308
  # the queue's default order or player latency information, if
@@ -2769,7 +3318,7 @@ module Aws::GameLift
2769
3318
  # where any individual player is reporting latency higher than a
2770
3319
  # policy's maximum.
2771
3320
  #
2772
- # Queue-related operations include the following:
3321
+ # Queue-related operations include:
2773
3322
  #
2774
3323
  # * CreateGameSessionQueue
2775
3324
  #
@@ -2780,8 +3329,8 @@ module Aws::GameLift
2780
3329
  # * DeleteGameSessionQueue
2781
3330
  #
2782
3331
  # @!attribute [rw] name
2783
- # Descriptive label that is associated with queue. Queue names must be
2784
- # unique within each region.
3332
+ # Descriptive label that is associated with game session queue. Queue
3333
+ # names must be unique within each region.
2785
3334
  # @return [String]
2786
3335
  #
2787
3336
  # @!attribute [rw] game_session_queue_arn
@@ -2797,7 +3346,7 @@ module Aws::GameLift
2797
3346
  # @!attribute [rw] timeout_in_seconds
2798
3347
  # Maximum time, in seconds, that a new game session placement request
2799
3348
  # remains in the queue. When a request exceeds this time, the game
2800
- # session placement changes to a TIMED\_OUT status.
3349
+ # session placement changes to a `TIMED_OUT` status.
2801
3350
  # @return [Integer]
2802
3351
  #
2803
3352
  # @!attribute [rw] player_latency_policies
@@ -2942,7 +3491,7 @@ module Aws::GameLift
2942
3491
  end
2943
3492
 
2944
3493
  # Properties that describe an instance of a virtual computing resource
2945
- # that hosts one or more game servers. A fleet contains zero or more
3494
+ # that hosts one or more game servers. A fleet may contain zero or more
2946
3495
  # instances.
2947
3496
  #
2948
3497
  # @!attribute [rw] fleet_id
@@ -3146,8 +3695,8 @@ module Aws::GameLift
3146
3695
  # @!attribute [rw] next_token
3147
3696
  # Token that indicates the start of the next sequential page of
3148
3697
  # results. Use the token that is returned with a previous call to this
3149
- # action. To specify the start of the result set, do not specify a
3150
- # value.
3698
+ # action. To start at the beginning of the result set, do not specify
3699
+ # a value.
3151
3700
  # @return [String]
3152
3701
  #
3153
3702
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListAliasesInput AWS API Documentation
@@ -3209,105 +3758,404 @@ module Aws::GameLift
3209
3758
  # fleets for this build.
3210
3759
  # @return [String]
3211
3760
  #
3212
- # @!attribute [rw] limit
3213
- # Maximum number of results to return. Use this parameter with
3214
- # `NextToken` to get results as a set of sequential pages.
3215
- # @return [Integer]
3761
+ # @!attribute [rw] limit
3762
+ # Maximum number of results to return. Use this parameter with
3763
+ # `NextToken` to get results as a set of sequential pages.
3764
+ # @return [Integer]
3765
+ #
3766
+ # @!attribute [rw] next_token
3767
+ # Token that indicates the start of the next sequential page of
3768
+ # results. Use the token that is returned with a previous call to this
3769
+ # action. To start at the beginning of the result set, do not specify
3770
+ # a value.
3771
+ # @return [String]
3772
+ #
3773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuildsInput AWS API Documentation
3774
+ #
3775
+ class ListBuildsInput < Struct.new(
3776
+ :status,
3777
+ :limit,
3778
+ :next_token)
3779
+ include Aws::Structure
3780
+ end
3781
+
3782
+ # Represents the returned data in response to a request action.
3783
+ #
3784
+ # @!attribute [rw] builds
3785
+ # Collection of build records that match the request.
3786
+ # @return [Array<Types::Build>]
3787
+ #
3788
+ # @!attribute [rw] next_token
3789
+ # Token that indicates where to resume retrieving results on the next
3790
+ # call to this action. If no token is returned, these results
3791
+ # represent the end of the list.
3792
+ # @return [String]
3793
+ #
3794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuildsOutput AWS API Documentation
3795
+ #
3796
+ class ListBuildsOutput < Struct.new(
3797
+ :builds,
3798
+ :next_token)
3799
+ include Aws::Structure
3800
+ end
3801
+
3802
+ # Represents the input for a request action.
3803
+ #
3804
+ # @note When making an API call, you may pass ListFleetsInput
3805
+ # data as a hash:
3806
+ #
3807
+ # {
3808
+ # build_id: "BuildId",
3809
+ # limit: 1,
3810
+ # next_token: "NonZeroAndMaxString",
3811
+ # }
3812
+ #
3813
+ # @!attribute [rw] build_id
3814
+ # Unique identifier for a build to return fleets for. Use this
3815
+ # parameter to return only fleets using the specified build. To
3816
+ # retrieve all fleets, leave this parameter empty.
3817
+ # @return [String]
3818
+ #
3819
+ # @!attribute [rw] limit
3820
+ # Maximum number of results to return. Use this parameter with
3821
+ # `NextToken` to get results as a set of sequential pages.
3822
+ # @return [Integer]
3823
+ #
3824
+ # @!attribute [rw] next_token
3825
+ # Token that indicates the start of the next sequential page of
3826
+ # results. Use the token that is returned with a previous call to this
3827
+ # action. To start at the beginning of the result set, do not specify
3828
+ # a value.
3829
+ # @return [String]
3830
+ #
3831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleetsInput AWS API Documentation
3832
+ #
3833
+ class ListFleetsInput < Struct.new(
3834
+ :build_id,
3835
+ :limit,
3836
+ :next_token)
3837
+ include Aws::Structure
3838
+ end
3839
+
3840
+ # Represents the returned data in response to a request action.
3841
+ #
3842
+ # @!attribute [rw] fleet_ids
3843
+ # Set of fleet IDs matching the list request. You can retrieve
3844
+ # additional information about all returned fleets by passing this
3845
+ # result set to a call to DescribeFleetAttributes,
3846
+ # DescribeFleetCapacity, or DescribeFleetUtilization.
3847
+ # @return [Array<String>]
3848
+ #
3849
+ # @!attribute [rw] next_token
3850
+ # Token that indicates where to resume retrieving results on the next
3851
+ # call to this action. If no token is returned, these results
3852
+ # represent the end of the list.
3853
+ # @return [String]
3854
+ #
3855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleetsOutput AWS API Documentation
3856
+ #
3857
+ class ListFleetsOutput < Struct.new(
3858
+ :fleet_ids,
3859
+ :next_token)
3860
+ include Aws::Structure
3861
+ end
3862
+
3863
+ # New player session created as a result of a successful FlexMatch
3864
+ # match. A successful match automatically creates new player sessions
3865
+ # for every player ID in the original matchmaking request.
3866
+ #
3867
+ # When players connect to the match's game session, they must include
3868
+ # both player ID and player session ID in order to claim their assigned
3869
+ # player slot.
3870
+ #
3871
+ # @!attribute [rw] player_id
3872
+ # Unique identifier for a player
3873
+ # @return [String]
3874
+ #
3875
+ # @!attribute [rw] player_session_id
3876
+ # Unique identifier for a player session
3877
+ # @return [String]
3878
+ #
3879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchedPlayerSession AWS API Documentation
3880
+ #
3881
+ class MatchedPlayerSession < Struct.new(
3882
+ :player_id,
3883
+ :player_session_id)
3884
+ include Aws::Structure
3885
+ end
3886
+
3887
+ # Guidelines for use with FlexMatch to match players into games. All
3888
+ # matchmaking requests must specify a matchmaking configuration.
3889
+ #
3890
+ # @!attribute [rw] name
3891
+ # Unique identifier for a matchmaking configuration. This name is used
3892
+ # to identify the configuration associated with a matchmaking request
3893
+ # or ticket.
3894
+ # @return [String]
3895
+ #
3896
+ # @!attribute [rw] description
3897
+ # Descriptive label that is associated with matchmaking configuration.
3898
+ # @return [String]
3899
+ #
3900
+ # @!attribute [rw] game_session_queue_arns
3901
+ # Amazon Resource Name ([ARN][1]) that is assigned to a game session
3902
+ # queue and uniquely identifies it. Format is
3903
+ # `arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
3904
+ # These queues are used when placing game sessions for matches that
3905
+ # are created with this matchmaking configuration. Queues can be
3906
+ # located in any region.
3907
+ #
3908
+ #
3909
+ #
3910
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
3911
+ # @return [Array<String>]
3912
+ #
3913
+ # @!attribute [rw] request_timeout_seconds
3914
+ # Maximum duration, in seconds, that a matchmaking ticket can remain
3915
+ # in process before timing out. Requests that time out can be
3916
+ # resubmitted as needed.
3917
+ # @return [Integer]
3918
+ #
3919
+ # @!attribute [rw] acceptance_timeout_seconds
3920
+ # Length of time (in seconds) to wait for players to accept a proposed
3921
+ # match. If any player rejects the match or fails to accept before the
3922
+ # timeout, the ticket continues to look for an acceptable match.
3923
+ # @return [Integer]
3924
+ #
3925
+ # @!attribute [rw] acceptance_required
3926
+ # Flag that determines whether or not a match that was created with
3927
+ # this configuration must be accepted by the matched players. To
3928
+ # require acceptance, set to TRUE.
3929
+ # @return [Boolean]
3930
+ #
3931
+ # @!attribute [rw] rule_set_name
3932
+ # Unique identifier for a matchmaking rule set to use with this
3933
+ # configuration. A matchmaking configuration can only use rule sets
3934
+ # that are defined in the same region.
3935
+ # @return [String]
3936
+ #
3937
+ # @!attribute [rw] notification_target
3938
+ # SNS topic ARN that is set up to receive matchmaking notifications.
3939
+ # @return [String]
3940
+ #
3941
+ # @!attribute [rw] additional_player_count
3942
+ # Number of player slots in a match to keep open for future players.
3943
+ # For example, if the configuration's rule set specifies a match for
3944
+ # a single 12-person team, and the additional player count is set to
3945
+ # 2, only 10 players are selected for the match.
3946
+ # @return [Integer]
3947
+ #
3948
+ # @!attribute [rw] custom_event_data
3949
+ # Information to attached to all events related to the matchmaking
3950
+ # configuration.
3951
+ # @return [String]
3952
+ #
3953
+ # @!attribute [rw] creation_time
3954
+ # Time stamp indicating when this data object was created. Format is a
3955
+ # number expressed in Unix time as milliseconds (for example
3956
+ # "1469498468.057").
3957
+ # @return [Time]
3958
+ #
3959
+ # @!attribute [rw] game_properties
3960
+ # Set of developer-defined properties for a game session, formatted as
3961
+ # a set of type:value pairs. These properties are included in the
3962
+ # GameSession object, which is passed to the game server with a
3963
+ # request to start a new game session (see [Start a Game Session][1]).
3964
+ # This information is added to the new GameSession object that is
3965
+ # created for a successful match.
3966
+ #
3967
+ #
3968
+ #
3969
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
3970
+ # @return [Array<Types::GameProperty>]
3971
+ #
3972
+ # @!attribute [rw] game_session_data
3973
+ # Set of developer-defined game session properties, formatted as a
3974
+ # single string value. This data is included in the GameSession
3975
+ # object, which is passed to the game server with a request to start a
3976
+ # new game session (see [Start a Game Session][1]). This information
3977
+ # is added to the new GameSession object that is created for a
3978
+ # successful match.
3979
+ #
3980
+ #
3981
+ #
3982
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
3983
+ # @return [String]
3984
+ #
3985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchmakingConfiguration AWS API Documentation
3986
+ #
3987
+ class MatchmakingConfiguration < Struct.new(
3988
+ :name,
3989
+ :description,
3990
+ :game_session_queue_arns,
3991
+ :request_timeout_seconds,
3992
+ :acceptance_timeout_seconds,
3993
+ :acceptance_required,
3994
+ :rule_set_name,
3995
+ :notification_target,
3996
+ :additional_player_count,
3997
+ :custom_event_data,
3998
+ :creation_time,
3999
+ :game_properties,
4000
+ :game_session_data)
4001
+ include Aws::Structure
4002
+ end
4003
+
4004
+ # Set of rule statements, used with FlexMatch, that determine how to
4005
+ # build a certain kind of player match. Each rule set describes a type
4006
+ # of group to be created and defines the parameters for acceptable
4007
+ # player matches. Rule sets are used in MatchmakingConfiguration
4008
+ # objects.
4009
+ #
4010
+ # A rule set may define the following elements for a match. For detailed
4011
+ # information and examples showing how to construct a rule set, see
4012
+ # [Create Matchmaking Rules for Your Game][1].
4013
+ #
4014
+ # * Teams -- Required. A rule set must define one or multiple teams for
4015
+ # the match and set minimum and maximum team sizes. For example, a
4016
+ # rule set might describe a 4x4 match that requires all eight slots to
4017
+ # be filled.
4018
+ #
4019
+ # * Player attributes -- Optional. These attributes specify a set of
4020
+ # player characteristics to evaluate when looking for a match.
4021
+ # Matchmaking requests that use a rule set with player attributes must
4022
+ # provide the corresponding attribute values. For example, an
4023
+ # attribute might specify a player's skill or level.
4024
+ #
4025
+ # * Rules -- Optional. Rules define how to evaluate potential players
4026
+ # for a match based on player attributes. A rule might specify minimum
4027
+ # requirements for individual players--such as each player must meet a
4028
+ # certain skill level, or may describe an entire group--such as all
4029
+ # teams must be evenly matched or have at least one player in a
4030
+ # certain role.
4031
+ #
4032
+ # * Expansions -- Optional. Expansions allow you to relax the rules
4033
+ # after a period of time if no acceptable matches are found. This
4034
+ # feature lets you balance getting players into games in a reasonable
4035
+ # amount of time instead of making them wait indefinitely for the best
4036
+ # possible match. For example, you might use an expansion to increase
4037
+ # the maximum skill variance between players after 30 seconds.
4038
+ #
4039
+ #
4040
+ #
4041
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/match-rules.html
3216
4042
  #
3217
- # @!attribute [rw] next_token
3218
- # Token that indicates the start of the next sequential page of
3219
- # results. Use the token that is returned with a previous call to this
3220
- # action. To specify the start of the result set, do not specify a
3221
- # value.
4043
+ # @!attribute [rw] rule_set_name
4044
+ # Unique identifier for a matchmaking rule set
3222
4045
  # @return [String]
3223
4046
  #
3224
- # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuildsInput AWS API Documentation
4047
+ # @!attribute [rw] rule_set_body
4048
+ # Collection of matchmaking rules, formatted as a JSON string. (Note
4049
+ # that comments14 are not allowed in JSON, but most elements support a
4050
+ # description field.)
4051
+ # @return [String]
3225
4052
  #
3226
- class ListBuildsInput < Struct.new(
3227
- :status,
3228
- :limit,
3229
- :next_token)
4053
+ # @!attribute [rw] creation_time
4054
+ # Time stamp indicating when this data object was created. Format is a
4055
+ # number expressed in Unix time as milliseconds (for example
4056
+ # "1469498468.057").
4057
+ # @return [Time]
4058
+ #
4059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchmakingRuleSet AWS API Documentation
4060
+ #
4061
+ class MatchmakingRuleSet < Struct.new(
4062
+ :rule_set_name,
4063
+ :rule_set_body,
4064
+ :creation_time)
3230
4065
  include Aws::Structure
3231
4066
  end
3232
4067
 
3233
- # Represents the returned data in response to a request action.
4068
+ # Ticket generated to track the progress of a matchmaking request. Each
4069
+ # ticket is uniquely identified by a ticket ID, supplied by the
4070
+ # requester, when creating a matchmaking request with StartMatchmaking.
4071
+ # Tickets can be retrieved by calling DescribeMatchmaking with the
4072
+ # ticket ID.
3234
4073
  #
3235
- # @!attribute [rw] builds
3236
- # Collection of build records that match the request.
3237
- # @return [Array<Types::Build>]
4074
+ # @!attribute [rw] ticket_id
4075
+ # Unique identifier for a matchmaking ticket.
4076
+ # @return [String]
3238
4077
  #
3239
- # @!attribute [rw] next_token
3240
- # Token that indicates where to resume retrieving results on the next
3241
- # call to this action. If no token is returned, these results
3242
- # represent the end of the list.
4078
+ # @!attribute [rw] configuration_name
4079
+ # Name of the MatchmakingConfiguration that is used with this ticket.
4080
+ # Matchmaking configurations determine how players are grouped into a
4081
+ # match and how a new game session is created for the match.
3243
4082
  # @return [String]
3244
4083
  #
3245
- # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListBuildsOutput AWS API Documentation
4084
+ # @!attribute [rw] status
4085
+ # Current status of the matchmaking request.
3246
4086
  #
3247
- class ListBuildsOutput < Struct.new(
3248
- :builds,
3249
- :next_token)
3250
- include Aws::Structure
3251
- end
3252
-
3253
- # Represents the input for a request action.
4087
+ # * **QUEUED** The matchmaking request has been received and is
4088
+ # currently waiting to be processed.
3254
4089
  #
3255
- # @note When making an API call, you may pass ListFleetsInput
3256
- # data as a hash:
4090
+ # * **SEARCHING** The matchmaking request is currently being
4091
+ # processed.
3257
4092
  #
3258
- # {
3259
- # build_id: "BuildId",
3260
- # limit: 1,
3261
- # next_token: "NonZeroAndMaxString",
3262
- # }
4093
+ # * **REQUIRES\_ACCEPTANCE** – A match has been proposed and the
4094
+ # players must accept the match (see AcceptMatch). This status is
4095
+ # used only with requests that use a matchmaking configuration with
4096
+ # a player acceptance requirement.
3263
4097
  #
3264
- # @!attribute [rw] build_id
3265
- # Unique identifier for a build to return fleets for. Use this
3266
- # parameter to return only fleets using the specified build. To
3267
- # retrieve all fleets, leave this parameter empty.
3268
- # @return [String]
4098
+ # * **PLACING** The FlexMatch engine has matched players and is in
4099
+ # the process of placing a new game session for the match.
3269
4100
  #
3270
- # @!attribute [rw] limit
3271
- # Maximum number of results to return. Use this parameter with
3272
- # `NextToken` to get results as a set of sequential pages.
3273
- # @return [Integer]
4101
+ # * **COMPLETED** Players have been matched and a game session is
4102
+ # ready to host the players. A ticket in this state contains the
4103
+ # necessary connection information for players.
3274
4104
  #
3275
- # @!attribute [rw] next_token
3276
- # Token that indicates the start of the next sequential page of
3277
- # results. Use the token that is returned with a previous call to this
3278
- # action. To specify the start of the result set, do not specify a
3279
- # value.
3280
- # @return [String]
4105
+ # * **FAILED** The matchmaking request was not completed. Tickets
4106
+ # with players who fail to accept a proposed match are placed in
4107
+ # `FAILED` status; new matchmaking requests can be submitted for
4108
+ # these players.
3281
4109
  #
3282
- # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleetsInput AWS API Documentation
4110
+ # * **CANCELLED** The matchmaking request was canceled with a call
4111
+ # to StopMatchmaking.
3283
4112
  #
3284
- class ListFleetsInput < Struct.new(
3285
- :build_id,
3286
- :limit,
3287
- :next_token)
3288
- include Aws::Structure
3289
- end
3290
-
3291
- # Represents the returned data in response to a request action.
4113
+ # * **TIMED\_OUT** The matchmaking request was not completed within
4114
+ # the duration specified in the matchmaking configuration.
4115
+ # Matchmaking requests that time out can be resubmitted.
4116
+ # @return [String]
3292
4117
  #
3293
- # @!attribute [rw] fleet_ids
3294
- # Set of fleet IDs matching the list request. You can retrieve
3295
- # additional information about all returned fleets by passing this
3296
- # result set to a call to DescribeFleetAttributes,
3297
- # DescribeFleetCapacity, or DescribeFleetUtilization.
3298
- # @return [Array<String>]
4118
+ # @!attribute [rw] status_reason
4119
+ # Code to explain the current status. For example, a status reason may
4120
+ # indicate when a ticket has returned to `SEARCHING` status after a
4121
+ # proposed match fails to receive player acceptances.
4122
+ # @return [String]
3299
4123
  #
3300
- # @!attribute [rw] next_token
3301
- # Token that indicates where to resume retrieving results on the next
3302
- # call to this action. If no token is returned, these results
3303
- # represent the end of the list.
4124
+ # @!attribute [rw] status_message
4125
+ # Additional information about the current status.
3304
4126
  # @return [String]
3305
4127
  #
3306
- # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListFleetsOutput AWS API Documentation
4128
+ # @!attribute [rw] start_time
4129
+ # Time stamp indicating when this matchmaking request was received.
4130
+ # Format is a number expressed in Unix time as milliseconds (for
4131
+ # example "1469498468.057").
4132
+ # @return [Time]
3307
4133
  #
3308
- class ListFleetsOutput < Struct.new(
3309
- :fleet_ids,
3310
- :next_token)
4134
+ # @!attribute [rw] players
4135
+ # A set of `Player` objects, each representing a player to find
4136
+ # matches for. Players are identified by a unique player ID and may
4137
+ # include latency data for use during matchmaking. If the ticket is in
4138
+ # status `COMPLETED`, the `Player` objects include the team the
4139
+ # players were assigned to in the resulting match.
4140
+ # @return [Array<Types::Player>]
4141
+ #
4142
+ # @!attribute [rw] game_session_connection_info
4143
+ # Identifier and connection information of the game session created
4144
+ # for the match. This information is added to the ticket only after
4145
+ # the matchmaking request has been successfully completed.
4146
+ # @return [Types::GameSessionConnectionInfo]
4147
+ #
4148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/MatchmakingTicket AWS API Documentation
4149
+ #
4150
+ class MatchmakingTicket < Struct.new(
4151
+ :ticket_id,
4152
+ :configuration_name,
4153
+ :status,
4154
+ :status_reason,
4155
+ :status_message,
4156
+ :start_time,
4157
+ :players,
4158
+ :game_session_connection_info)
3311
4159
  include Aws::Structure
3312
4160
  end
3313
4161
 
@@ -3349,6 +4197,67 @@ module Aws::GameLift
3349
4197
  include Aws::Structure
3350
4198
  end
3351
4199
 
4200
+ # Object used in matchmaking to represent a player. When starting a
4201
+ # matchmaking request, a player has a player ID and may have latency
4202
+ # data. Team information is added after a match has been successfully
4203
+ # completed.
4204
+ #
4205
+ # @note When making an API call, you may pass Player
4206
+ # data as a hash:
4207
+ #
4208
+ # {
4209
+ # player_id: "PlayerIdStringModel",
4210
+ # player_attributes: {
4211
+ # "NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
4212
+ # },
4213
+ # team: "NonZeroAndMaxString",
4214
+ # latency_in_ms: {
4215
+ # "NonEmptyString" => 1,
4216
+ # },
4217
+ # }
4218
+ #
4219
+ # @!attribute [rw] player_id
4220
+ # Unique identifier for a player
4221
+ # @return [String]
4222
+ #
4223
+ # @!attribute [rw] player_attributes
4224
+ # Collection of name:value pairs containing player information for use
4225
+ # in matchmaking. Player attribute names need to match
4226
+ # *playerAttributes* names in the rule set being used. Example:
4227
+ # `"PlayerAttributes": \{"skill": \{"N": "23"\}, "gameMode": \{"S":
4228
+ # "deathmatch"\}\}`.
4229
+ # @return [Hash<String,Types::AttributeValue>]
4230
+ #
4231
+ # @!attribute [rw] team
4232
+ # Name of the team that the player is assigned to in a match. Team
4233
+ # names are defined in a matchmaking rule set.
4234
+ # @return [String]
4235
+ #
4236
+ # @!attribute [rw] latency_in_ms
4237
+ # Set of values, expressed in milliseconds, indicating the amount of
4238
+ # latency that a player experiences when connected to AWS regions. If
4239
+ # this property is present, FlexMatch considers placing the match only
4240
+ # in regions that are included in the object map. If not present (that
4241
+ # is, null), FlexMatch ignores latency issues and may place the match
4242
+ # in any region in the queue.
4243
+ #
4244
+ # <note markdown="1"> If this property contains an empty map, FlexMatch assumes that no
4245
+ # regions are available to the player. In this scenario, the ticket is
4246
+ # not matchable and always times out unless canceled.
4247
+ #
4248
+ # </note>
4249
+ # @return [Hash<String,Integer>]
4250
+ #
4251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/Player AWS API Documentation
4252
+ #
4253
+ class Player < Struct.new(
4254
+ :player_id,
4255
+ :player_attributes,
4256
+ :team,
4257
+ :latency_in_ms)
4258
+ include Aws::Structure
4259
+ end
4260
+
3352
4261
  # Regional latency information for a player, used when requesting a new
3353
4262
  # game session with StartGameSessionPlacement. This value indicates the
3354
4263
  # amount of time lag that exists when the player is connected to a fleet
@@ -3431,11 +4340,18 @@ module Aws::GameLift
3431
4340
  include Aws::Structure
3432
4341
  end
3433
4342
 
3434
- # Properties describing a player session. A player session represents
3435
- # either a player reservation for a game session or actual player
3436
- # activity in a game session. A player session object (including player
3437
- # data) is automatically passed to a game session when the player
3438
- # connects to the game session and is validated.
4343
+ # Properties describing a player session. Player session objects are
4344
+ # created either by creating a player session for a specific game
4345
+ # session, or as part of a game session placement. A player session
4346
+ # represents either a player reservation for a game session (status
4347
+ # `RESERVED`) or actual player activity in a game session (status
4348
+ # `ACTIVE`). A player session object (including player data) is
4349
+ # automatically passed to a game session when the player connects to the
4350
+ # game session and is validated.
4351
+ #
4352
+ # When a player disconnects, the player session status changes to
4353
+ # `COMPLETED`. Once the session ends, the player session object is
4354
+ # retained for 30 days and then removed.
3439
4355
  #
3440
4356
  # Player-session-related operations include:
3441
4357
  #
@@ -3851,7 +4767,7 @@ module Aws::GameLift
3851
4767
 
3852
4768
  # A collection of server process configurations that describe what
3853
4769
  # processes to run on each instance in a fleet. All fleets must have a
3854
- # runtime configuration. Each instance in the fleet launches the server
4770
+ # run-time configuration. Each instance in the fleet launches the server
3855
4771
  # processes specified in the run-time configuration and launches new
3856
4772
  # ones as existing processes end. Each instance regularly checks for an
3857
4773
  # updated run-time configuration and follows the new instructions.
@@ -4259,8 +5175,8 @@ module Aws::GameLift
4259
5175
  # @!attribute [rw] next_token
4260
5176
  # Token that indicates the start of the next sequential page of
4261
5177
  # results. Use the token that is returned with a previous call to this
4262
- # action. To specify the start of the result set, do not specify a
4263
- # value.
5178
+ # action. To start at the beginning of the result set, do not specify
5179
+ # a value.
4264
5180
  # @return [String]
4265
5181
  #
4266
5182
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SearchGameSessionsInput AWS API Documentation
@@ -4371,6 +5287,7 @@ module Aws::GameLift
4371
5287
  # player_data: "PlayerData",
4372
5288
  # },
4373
5289
  # ],
5290
+ # game_session_data: "GameSessionData",
4374
5291
  # }
4375
5292
  #
4376
5293
  # @!attribute [rw] placement_id
@@ -4385,9 +5302,14 @@ module Aws::GameLift
4385
5302
  # @return [String]
4386
5303
  #
4387
5304
  # @!attribute [rw] game_properties
4388
- # Set of developer-defined properties for a game session. These
4389
- # properties are passed to the server process hosting the game
4390
- # session.
5305
+ # Set of developer-defined properties for a game session, formatted as
5306
+ # a set of type:value pairs. These properties are included in the
5307
+ # GameSession object, which is passed to the game server with a
5308
+ # request to start a new game session (see [Start a Game Session][1]).
5309
+ #
5310
+ #
5311
+ #
5312
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
4391
5313
  # @return [Array<Types::GameProperty>]
4392
5314
  #
4393
5315
  # @!attribute [rw] maximum_player_session_count
@@ -4402,7 +5324,7 @@ module Aws::GameLift
4402
5324
  #
4403
5325
  # @!attribute [rw] player_latencies
4404
5326
  # Set of values, expressed in milliseconds, indicating the amount of
4405
- # latency that players are experiencing when connected to AWS regions.
5327
+ # latency that a player experiences when connected to AWS regions.
4406
5328
  # This information is used to try to place the new game session where
4407
5329
  # it can offer the best possible gameplay experience for the players.
4408
5330
  # @return [Array<Types::PlayerLatency>]
@@ -4411,6 +5333,17 @@ module Aws::GameLift
4411
5333
  # Set of information on each player to create a player session for.
4412
5334
  # @return [Array<Types::DesiredPlayerSession>]
4413
5335
  #
5336
+ # @!attribute [rw] game_session_data
5337
+ # Set of developer-defined game session properties, formatted as a
5338
+ # single string value. This data is included in the GameSession
5339
+ # object, which is passed to the game server with a request to start a
5340
+ # new game session (see [Start a Game Session][1]).
5341
+ #
5342
+ #
5343
+ #
5344
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
5345
+ # @return [String]
5346
+ #
4414
5347
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacementInput AWS API Documentation
4415
5348
  #
4416
5349
  class StartGameSessionPlacementInput < Struct.new(
@@ -4420,7 +5353,8 @@ module Aws::GameLift
4420
5353
  :maximum_player_session_count,
4421
5354
  :game_session_name,
4422
5355
  :player_latencies,
4423
- :desired_player_sessions)
5356
+ :desired_player_sessions,
5357
+ :game_session_data)
4424
5358
  include Aws::Structure
4425
5359
  end
4426
5360
 
@@ -4439,6 +5373,71 @@ module Aws::GameLift
4439
5373
  include Aws::Structure
4440
5374
  end
4441
5375
 
5376
+ # Represents the input for a request action.
5377
+ #
5378
+ # @note When making an API call, you may pass StartMatchmakingInput
5379
+ # data as a hash:
5380
+ #
5381
+ # {
5382
+ # ticket_id: "MatchmakingIdStringModel",
5383
+ # configuration_name: "MatchmakingIdStringModel", # required
5384
+ # players: [ # required
5385
+ # {
5386
+ # player_id: "PlayerIdStringModel",
5387
+ # player_attributes: {
5388
+ # "NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
5389
+ # },
5390
+ # team: "NonZeroAndMaxString",
5391
+ # latency_in_ms: {
5392
+ # "NonEmptyString" => 1,
5393
+ # },
5394
+ # },
5395
+ # ],
5396
+ # }
5397
+ #
5398
+ # @!attribute [rw] ticket_id
5399
+ # Unique identifier for a matchmaking ticket. Use this identifier to
5400
+ # track the matchmaking ticket status and retrieve match results.
5401
+ # @return [String]
5402
+ #
5403
+ # @!attribute [rw] configuration_name
5404
+ # Name of the matchmaking configuration to use for this request.
5405
+ # Matchmaking configurations must exist in the same region as this
5406
+ # request.
5407
+ # @return [String]
5408
+ #
5409
+ # @!attribute [rw] players
5410
+ # Information on each player to be matched. This information must
5411
+ # include a player ID, and may contain player attributes and latency
5412
+ # data to be used in the matchmaking process. After a successful
5413
+ # match, `Player` objects contain the name of the team the player is
5414
+ # assigned to.
5415
+ # @return [Array<Types::Player>]
5416
+ #
5417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchmakingInput AWS API Documentation
5418
+ #
5419
+ class StartMatchmakingInput < Struct.new(
5420
+ :ticket_id,
5421
+ :configuration_name,
5422
+ :players)
5423
+ include Aws::Structure
5424
+ end
5425
+
5426
+ # Represents the returned data in response to a request action.
5427
+ #
5428
+ # @!attribute [rw] matchmaking_ticket
5429
+ # Ticket representing the matchmaking request. This object include the
5430
+ # information included in the request, ticket status, and match
5431
+ # results as generated during the matchmaking process.
5432
+ # @return [Types::MatchmakingTicket]
5433
+ #
5434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchmakingOutput AWS API Documentation
5435
+ #
5436
+ class StartMatchmakingOutput < Struct.new(
5437
+ :matchmaking_ticket)
5438
+ include Aws::Structure
5439
+ end
5440
+
4442
5441
  # Represents the input for a request action.
4443
5442
  #
4444
5443
  # @note When making an API call, you may pass StopGameSessionPlacementInput
@@ -4463,7 +5462,7 @@ module Aws::GameLift
4463
5462
  #
4464
5463
  # @!attribute [rw] game_session_placement
4465
5464
  # Object that describes the canceled game session placement, with
4466
- # Cancelled status and an end time stamp.
5465
+ # `CANCELLED` status and an end time stamp.
4467
5466
  # @return [Types::GameSessionPlacement]
4468
5467
  #
4469
5468
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopGameSessionPlacementOutput AWS API Documentation
@@ -4473,6 +5472,30 @@ module Aws::GameLift
4473
5472
  include Aws::Structure
4474
5473
  end
4475
5474
 
5475
+ # Represents the input for a request action.
5476
+ #
5477
+ # @note When making an API call, you may pass StopMatchmakingInput
5478
+ # data as a hash:
5479
+ #
5480
+ # {
5481
+ # ticket_id: "MatchmakingIdStringModel", # required
5482
+ # }
5483
+ #
5484
+ # @!attribute [rw] ticket_id
5485
+ # Unique identifier for a matchmaking ticket.
5486
+ # @return [String]
5487
+ #
5488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopMatchmakingInput AWS API Documentation
5489
+ #
5490
+ class StopMatchmakingInput < Struct.new(
5491
+ :ticket_id)
5492
+ include Aws::Structure
5493
+ end
5494
+
5495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopMatchmakingOutput AWS API Documentation
5496
+ #
5497
+ class StopMatchmakingOutput < Aws::EmptyStructure; end
5498
+
4476
5499
  # Represents the input for a request action.
4477
5500
  #
4478
5501
  # @note When making an API call, you may pass UpdateAliasInput
@@ -4858,14 +5881,14 @@ module Aws::GameLift
4858
5881
  # }
4859
5882
  #
4860
5883
  # @!attribute [rw] name
4861
- # Descriptive label that is associated with queue. Queue names must be
4862
- # unique within each region.
5884
+ # Descriptive label that is associated with game session queue. Queue
5885
+ # names must be unique within each region.
4863
5886
  # @return [String]
4864
5887
  #
4865
5888
  # @!attribute [rw] timeout_in_seconds
4866
5889
  # Maximum time, in seconds, that a new game session placement request
4867
5890
  # remains in the queue. When a request exceeds this time, the game
4868
- # session placement changes to a TIMED\_OUT status.
5891
+ # session placement changes to a `TIMED_OUT` status.
4869
5892
  # @return [Integer]
4870
5893
  #
4871
5894
  # @!attribute [rw] player_latency_policies
@@ -4912,6 +5935,155 @@ module Aws::GameLift
4912
5935
  include Aws::Structure
4913
5936
  end
4914
5937
 
5938
+ # Represents the input for a request action.
5939
+ #
5940
+ # @note When making an API call, you may pass UpdateMatchmakingConfigurationInput
5941
+ # data as a hash:
5942
+ #
5943
+ # {
5944
+ # name: "MatchmakingIdStringModel", # required
5945
+ # description: "NonZeroAndMaxString",
5946
+ # game_session_queue_arns: ["ArnStringModel"],
5947
+ # request_timeout_seconds: 1,
5948
+ # acceptance_timeout_seconds: 1,
5949
+ # acceptance_required: false,
5950
+ # rule_set_name: "MatchmakingIdStringModel",
5951
+ # notification_target: "SnsArnStringModel",
5952
+ # additional_player_count: 1,
5953
+ # custom_event_data: "CustomEventData",
5954
+ # game_properties: [
5955
+ # {
5956
+ # key: "GamePropertyKey", # required
5957
+ # value: "GamePropertyValue", # required
5958
+ # },
5959
+ # ],
5960
+ # game_session_data: "GameSessionData",
5961
+ # }
5962
+ #
5963
+ # @!attribute [rw] name
5964
+ # Unique identifier for a matchmaking configuration to update.
5965
+ # @return [String]
5966
+ #
5967
+ # @!attribute [rw] description
5968
+ # Descriptive label that is associated with matchmaking configuration.
5969
+ # @return [String]
5970
+ #
5971
+ # @!attribute [rw] game_session_queue_arns
5972
+ # Amazon Resource Name ([ARN][1]) that is assigned to a game session
5973
+ # queue and uniquely identifies it. Format is
5974
+ # `arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
5975
+ # These queues are used when placing game sessions for matches that
5976
+ # are created with this matchmaking configuration. Queues can be
5977
+ # located in any region.
5978
+ #
5979
+ #
5980
+ #
5981
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
5982
+ # @return [Array<String>]
5983
+ #
5984
+ # @!attribute [rw] request_timeout_seconds
5985
+ # Maximum duration, in seconds, that a matchmaking ticket can remain
5986
+ # in process before timing out. Requests that time out can be
5987
+ # resubmitted as needed.
5988
+ # @return [Integer]
5989
+ #
5990
+ # @!attribute [rw] acceptance_timeout_seconds
5991
+ # Length of time (in seconds) to wait for players to accept a proposed
5992
+ # match. If any player rejects the match or fails to accept before the
5993
+ # timeout, the ticket continues to look for an acceptable match.
5994
+ # @return [Integer]
5995
+ #
5996
+ # @!attribute [rw] acceptance_required
5997
+ # Flag that determines whether or not a match that was created with
5998
+ # this configuration must be accepted by the matched players. To
5999
+ # require acceptance, set to TRUE.
6000
+ # @return [Boolean]
6001
+ #
6002
+ # @!attribute [rw] rule_set_name
6003
+ # Unique identifier for a matchmaking rule set to use with this
6004
+ # configuration. A matchmaking configuration can only use rule sets
6005
+ # that are defined in the same region.
6006
+ # @return [String]
6007
+ #
6008
+ # @!attribute [rw] notification_target
6009
+ # SNS topic ARN that is set up to receive matchmaking notifications.
6010
+ # See [ Setting up Notifications for Matchmaking][1] for more
6011
+ # information.
6012
+ #
6013
+ #
6014
+ #
6015
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
6016
+ # @return [String]
6017
+ #
6018
+ # @!attribute [rw] additional_player_count
6019
+ # Number of player slots in a match to keep open for future players.
6020
+ # For example, if the configuration's rule set specifies a match for
6021
+ # a single 12-person team, and the additional player count is set to
6022
+ # 2, only 10 players are selected for the match.
6023
+ # @return [Integer]
6024
+ #
6025
+ # @!attribute [rw] custom_event_data
6026
+ # Information to attached to all events related to the matchmaking
6027
+ # configuration.
6028
+ # @return [String]
6029
+ #
6030
+ # @!attribute [rw] game_properties
6031
+ # Set of developer-defined properties for a game session, formatted as
6032
+ # a set of type:value pairs. These properties are included in the
6033
+ # GameSession object, which is passed to the game server with a
6034
+ # request to start a new game session (see [Start a Game Session][1]).
6035
+ # This information is added to the new GameSession object that is
6036
+ # created for a successful match.
6037
+ #
6038
+ #
6039
+ #
6040
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
6041
+ # @return [Array<Types::GameProperty>]
6042
+ #
6043
+ # @!attribute [rw] game_session_data
6044
+ # Set of developer-defined game session properties, formatted as a
6045
+ # single string value. This data is included in the GameSession
6046
+ # object, which is passed to the game server with a request to start a
6047
+ # new game session (see [Start a Game Session][1]). This information
6048
+ # is added to the new GameSession object that is created for a
6049
+ # successful match.
6050
+ #
6051
+ #
6052
+ #
6053
+ # [1]: http://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
6054
+ # @return [String]
6055
+ #
6056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfigurationInput AWS API Documentation
6057
+ #
6058
+ class UpdateMatchmakingConfigurationInput < Struct.new(
6059
+ :name,
6060
+ :description,
6061
+ :game_session_queue_arns,
6062
+ :request_timeout_seconds,
6063
+ :acceptance_timeout_seconds,
6064
+ :acceptance_required,
6065
+ :rule_set_name,
6066
+ :notification_target,
6067
+ :additional_player_count,
6068
+ :custom_event_data,
6069
+ :game_properties,
6070
+ :game_session_data)
6071
+ include Aws::Structure
6072
+ end
6073
+
6074
+ # Represents the returned data in response to a request action.
6075
+ #
6076
+ # @!attribute [rw] configuration
6077
+ # Object that describes the updated matchmaking configuration.
6078
+ # @return [Types::MatchmakingConfiguration]
6079
+ #
6080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfigurationOutput AWS API Documentation
6081
+ #
6082
+ class UpdateMatchmakingConfigurationOutput < Struct.new(
6083
+ :configuration)
6084
+ include Aws::Structure
6085
+ end
6086
+
4915
6087
  # Represents the input for a request action.
4916
6088
  #
4917
6089
  # @note When making an API call, you may pass UpdateRuntimeConfigurationInput
@@ -4968,5 +6140,39 @@ module Aws::GameLift
4968
6140
  include Aws::Structure
4969
6141
  end
4970
6142
 
6143
+ # Represents the input for a request action.
6144
+ #
6145
+ # @note When making an API call, you may pass ValidateMatchmakingRuleSetInput
6146
+ # data as a hash:
6147
+ #
6148
+ # {
6149
+ # rule_set_body: "RuleSetBody", # required
6150
+ # }
6151
+ #
6152
+ # @!attribute [rw] rule_set_body
6153
+ # Collection of matchmaking rules to validate, formatted as a JSON
6154
+ # string.
6155
+ # @return [String]
6156
+ #
6157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ValidateMatchmakingRuleSetInput AWS API Documentation
6158
+ #
6159
+ class ValidateMatchmakingRuleSetInput < Struct.new(
6160
+ :rule_set_body)
6161
+ include Aws::Structure
6162
+ end
6163
+
6164
+ # Represents the returned data in response to a request action.
6165
+ #
6166
+ # @!attribute [rw] valid
6167
+ # Response indicating whether or not the rule set is valid.
6168
+ # @return [Boolean]
6169
+ #
6170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ValidateMatchmakingRuleSetOutput AWS API Documentation
6171
+ #
6172
+ class ValidateMatchmakingRuleSetOutput < Struct.new(
6173
+ :valid)
6174
+ include Aws::Structure
6175
+ end
6176
+
4971
6177
  end
4972
6178
  end