aws-sdk-gameliftstreams 1.10.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-gameliftstreams/client.rb +218 -95
- data/lib/aws-sdk-gameliftstreams/client_api.rb +1 -0
- data/lib/aws-sdk-gameliftstreams/types.rb +228 -121
- data/lib/aws-sdk-gameliftstreams.rb +1 -1
- data/sig/client.rbs +2 -1
- data/sig/types.rbs +1 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 48ec447347b4a5c5224ecd2bc1d23d928ff516b6b954770ae1af86d7e5f33136
|
4
|
+
data.tar.gz: a10266639fdaa98f458c2267f418cd772c8913429659ccf9b2d217bd7a4bd23e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ef57c4d0336f94b9cfd8f75704daea91c1de36c05bbaa6f9e6dfc53141507e16bfa9053afdb64eb1f9db471d675771182c80a3363e546eafe0f105571aa84e75
|
7
|
+
data.tar.gz: c52f4bcbcc9f1ee3744933c6ed70ce57dd5e1986f5564c86d47503b2fe3d7449900577f5e0fcf2d8d087da9223985ce4cf26dbe2ef738e6297ea15aa2c001f76
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.11.0 (2025-08-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - The default application in a stream group can now be changed at any time using UpdateStreamGroup to update the DefaultApplicationIdentifier.
|
8
|
+
|
4
9
|
1.10.0 (2025-08-08)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.11.0
|
@@ -550,6 +550,10 @@ module Aws::GameLiftStreams
|
|
550
550
|
# `ACTIVE` status. You can reverse this action by using
|
551
551
|
# [DisassociateApplications][1].
|
552
552
|
#
|
553
|
+
# If a stream group does not already have a linked application, Amazon
|
554
|
+
# GameLift Streams will automatically assign the first application
|
555
|
+
# provided in `ApplicationIdentifiers` as the default.
|
556
|
+
#
|
553
557
|
#
|
554
558
|
#
|
555
559
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html
|
@@ -812,13 +816,15 @@ module Aws::GameLiftStreams
|
|
812
816
|
# * **Always-on**: The streaming capacity that is allocated and ready to
|
813
817
|
# handle stream requests without delay. You pay for this capacity
|
814
818
|
# whether it's in use or not. Best for quickest time from streaming
|
815
|
-
# request to streaming session.
|
819
|
+
# request to streaming session. Default is 1 when creating a stream
|
820
|
+
# group or adding a location.
|
816
821
|
#
|
817
822
|
# * **On-demand**: The streaming capacity that Amazon GameLift Streams
|
818
823
|
# can allocate in response to stream requests, and then de-allocate
|
819
824
|
# when the session has terminated. This offers a cost control measure
|
820
825
|
# at the expense of a greater startup time (typically under 5
|
821
|
-
# minutes).
|
826
|
+
# minutes). Default is 0 when creating a stream group or adding a
|
827
|
+
# location.
|
822
828
|
#
|
823
829
|
# To adjust the capacity of any `ACTIVE` stream group, call
|
824
830
|
# [UpdateStreamGroup][1].
|
@@ -923,23 +929,25 @@ module Aws::GameLiftStreams
|
|
923
929
|
#
|
924
930
|
# @option params [String] :default_application_identifier
|
925
931
|
# The unique identifier of the Amazon GameLift Streams application that
|
926
|
-
# you want to
|
927
|
-
#
|
928
|
-
# application
|
929
|
-
#
|
930
|
-
#
|
931
|
-
# associated using AssociateApplications. If not set when creating a
|
932
|
-
# stream group, you will need to call AssociateApplications later,
|
933
|
-
# before you can start streaming.
|
932
|
+
# you want to set as the default application in a stream group. The
|
933
|
+
# application that you specify must be in `READY` status. The default
|
934
|
+
# application is pre-cached on always-on compute resources, reducing
|
935
|
+
# stream startup times. Other applications are automatically cached as
|
936
|
+
# needed.
|
934
937
|
#
|
935
|
-
#
|
938
|
+
# If you do not link an application when you create a stream group, you
|
939
|
+
# will need to link one later, before you can start streaming, using
|
940
|
+
# [AssociateApplications][1].
|
941
|
+
#
|
942
|
+
# This value is an [Amazon Resource Name (ARN)][2] or ID that uniquely
|
936
943
|
# identifies the application resource. Example ARN:
|
937
944
|
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
938
945
|
# Example ID: `a-9ZY8X7Wv6`.
|
939
946
|
#
|
940
947
|
#
|
941
948
|
#
|
942
|
-
# [1]: https://docs.aws.amazon.com/
|
949
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
|
950
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
943
951
|
#
|
944
952
|
# @option params [Array<Types::LocationConfiguration>] :location_configurations
|
945
953
|
# A set of one or more locations and the streaming capacity for each
|
@@ -1035,29 +1043,52 @@ module Aws::GameLiftStreams
|
|
1035
1043
|
req.send_request(options)
|
1036
1044
|
end
|
1037
1045
|
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
#
|
1045
|
-
#
|
1046
|
-
#
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
#
|
1060
|
-
#
|
1046
|
+
# Enables clients to reconnect to a stream session while preserving all
|
1047
|
+
# session state and data in the disconnected session. This reconnection
|
1048
|
+
# process can be initiated when a stream session is in either
|
1049
|
+
# `PENDING_CLIENT_RECONNECTION` or `ACTIVE` status. The process works as
|
1050
|
+
# follows:
|
1051
|
+
#
|
1052
|
+
# 1. Initial disconnect:
|
1053
|
+
#
|
1054
|
+
# * When a client disconnects or loses connection, the stream
|
1055
|
+
# session transitions from `CONNECTED` to
|
1056
|
+
# `PENDING_CLIENT_RECONNECTION`
|
1057
|
+
#
|
1058
|
+
# ^
|
1059
|
+
# 2. Reconnection time window:
|
1060
|
+
#
|
1061
|
+
# * Clients have `ConnectionTimeoutSeconds` (defined in
|
1062
|
+
# [StartStreamSession][1]) to reconnect before session termination
|
1063
|
+
#
|
1064
|
+
# * Your backend server must call **CreateStreamSessionConnection**
|
1065
|
+
# to initiate reconnection
|
1066
|
+
#
|
1067
|
+
# * Session transitions to `RECONNECTING` status
|
1068
|
+
# 3. Reconnection completion:
|
1069
|
+
#
|
1070
|
+
# * On successful **CreateStreamSessionConnection**, session status
|
1071
|
+
# changes to `ACTIVE`
|
1072
|
+
#
|
1073
|
+
# * Provide the new connection information to the requesting client
|
1074
|
+
#
|
1075
|
+
# * Client must establish connection within
|
1076
|
+
# `ConnectionTimeoutSeconds`
|
1077
|
+
#
|
1078
|
+
# * Session terminates automatically if client fails to connect in
|
1079
|
+
# time
|
1080
|
+
#
|
1081
|
+
# For more information about the stream session lifecycle, see [Stream
|
1082
|
+
# sessions][2] in the *Amazon GameLift Streams Developer Guide*.
|
1083
|
+
#
|
1084
|
+
# To begin re-connecting to an existing stream session, specify the
|
1085
|
+
# stream group ID and stream session ID that you want to reconnect to,
|
1086
|
+
# and the signal request to use with the stream.
|
1087
|
+
#
|
1088
|
+
#
|
1089
|
+
#
|
1090
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html
|
1091
|
+
# [2]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/stream-sessions.html
|
1061
1092
|
#
|
1062
1093
|
# @option params [String] :client_token
|
1063
1094
|
# A unique identifier that represents a client request. The request is
|
@@ -1075,7 +1106,7 @@ module Aws::GameLiftStreams
|
|
1075
1106
|
# Example ID: `sg-1AB2C3De4`.
|
1076
1107
|
#
|
1077
1108
|
# The stream group that you want to run this stream session with. The
|
1078
|
-
# stream group must be in `ACTIVE` status
|
1109
|
+
# stream group must be in `ACTIVE` status.
|
1079
1110
|
#
|
1080
1111
|
#
|
1081
1112
|
#
|
@@ -1232,16 +1263,19 @@ module Aws::GameLiftStreams
|
|
1232
1263
|
# group's allocated compute resources. Any streams in process will
|
1233
1264
|
# continue until they terminate, which helps avoid interrupting an
|
1234
1265
|
# end-user's stream. Amazon GameLift Streams will not initiate new
|
1235
|
-
# streams
|
1236
|
-
# affect the stream capacity of a stream
|
1266
|
+
# streams in the stream group using the disassociated application. The
|
1267
|
+
# disassociate action does not affect the stream capacity of a stream
|
1268
|
+
# group.
|
1237
1269
|
#
|
1238
|
-
#
|
1239
|
-
#
|
1240
|
-
#
|
1270
|
+
# If you disassociate the default application, Amazon GameLift Streams
|
1271
|
+
# will automatically choose a new default application from the remaining
|
1272
|
+
# associated applications. To change which application is the default
|
1273
|
+
# application, call [UpdateStreamGroup][1] and specify a new
|
1274
|
+
# `DefaultApplicationIdentifier`.
|
1241
1275
|
#
|
1242
1276
|
#
|
1243
1277
|
#
|
1244
|
-
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/
|
1278
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html
|
1245
1279
|
#
|
1246
1280
|
# @option params [required, String] :identifier
|
1247
1281
|
# A stream group to disassociate these applications from.
|
@@ -1758,13 +1792,13 @@ module Aws::GameLiftStreams
|
|
1758
1792
|
#
|
1759
1793
|
# Exported files can be in one of the following states:
|
1760
1794
|
#
|
1761
|
-
# *
|
1795
|
+
# * `SUCCEEDED`: The exported files are successfully stored in an S3
|
1762
1796
|
# bucket.
|
1763
1797
|
#
|
1764
|
-
# *
|
1765
|
-
# collect and upload the to S3.
|
1798
|
+
# * `FAILED`: The session ended but Amazon GameLift Streams couldn't
|
1799
|
+
# collect and upload the files to S3.
|
1766
1800
|
#
|
1767
|
-
# *
|
1801
|
+
# * `PENDING`: Either the stream session is still in progress, or
|
1768
1802
|
# uploading the exported files to the S3 bucket is in progress.
|
1769
1803
|
#
|
1770
1804
|
# @option params [String] :next_token
|
@@ -1976,12 +2010,12 @@ module Aws::GameLiftStreams
|
|
1976
2010
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1977
2011
|
#
|
1978
2012
|
# @option params [required, Array<String>] :locations
|
1979
|
-
# A set of locations to remove this stream group.
|
2013
|
+
# A set of locations to remove this stream group. For example,
|
2014
|
+
# `us-east-1`.
|
1980
2015
|
#
|
1981
|
-
#
|
1982
|
-
#
|
1983
|
-
#
|
1984
|
-
# Guide*.
|
2016
|
+
# For a complete list of locations that Amazon GameLift Streams
|
2017
|
+
# supports, refer to [Regions, quotas, and limitations][1] in the
|
2018
|
+
# *Amazon GameLift Streams Developer Guide*.
|
1985
2019
|
#
|
1986
2020
|
#
|
1987
2021
|
#
|
@@ -2009,42 +2043,102 @@ module Aws::GameLiftStreams
|
|
2009
2043
|
# information that clients can use to access the stream. A stream
|
2010
2044
|
# session refers to an instance of a stream that Amazon GameLift Streams
|
2011
2045
|
# transmits from the server to the end-user. A stream session runs on a
|
2012
|
-
# compute resource that a stream group has allocated.
|
2046
|
+
# compute resource that a stream group has allocated. The start stream
|
2047
|
+
# session process works as follows:
|
2048
|
+
#
|
2049
|
+
# 1. Prerequisites:
|
2050
|
+
#
|
2051
|
+
# * You must have a stream group in `ACTIVE` state
|
2052
|
+
#
|
2053
|
+
# * You must have idle or on-demand capacity in a stream group in
|
2054
|
+
# the location you want to stream from
|
2055
|
+
#
|
2056
|
+
# * You must have at least one application associated to the stream
|
2057
|
+
# group (use [AssociateApplications][1] if needed)
|
2058
|
+
# 2. Start stream request:
|
2059
|
+
#
|
2060
|
+
# * Your backend server calls **StartStreamSession** to initiate
|
2061
|
+
# connection
|
2062
|
+
#
|
2063
|
+
# * Amazon GameLift Streams creates the stream session resource,
|
2064
|
+
# assigns an Amazon Resource Name (ARN) value, and begins
|
2065
|
+
# searching for available stream capacity to run the stream
|
2066
|
+
#
|
2067
|
+
# * Session transitions to `ACTIVATING` status
|
2068
|
+
# 3. Placement completion:
|
2069
|
+
#
|
2070
|
+
# * If Amazon GameLift Streams is successful in finding capacity for
|
2071
|
+
# the stream, the stream session status changes to `ACTIVE` status
|
2072
|
+
# and **StartStreamSession** returns stream connection information
|
2013
2073
|
#
|
2014
|
-
#
|
2015
|
-
#
|
2016
|
-
#
|
2017
|
-
# to
|
2018
|
-
#
|
2074
|
+
# * If Amazon GameLift Streams was not successful in finding
|
2075
|
+
# capacity within the placement timeout period (defined according
|
2076
|
+
# to the capacity type and platform type), the stream session
|
2077
|
+
# status changes to `ERROR` status and **StartStreamSession**
|
2078
|
+
# returns a `StatusReason` of `placementTimeout`
|
2079
|
+
# 4. Connection completion:
|
2080
|
+
#
|
2081
|
+
# * Provide the new connection information to the requesting client
|
2082
|
+
#
|
2083
|
+
# * Client must establish connection within
|
2084
|
+
# `ConnectionTimeoutSeconds` (specified in **StartStreamSession**
|
2085
|
+
# parameters)
|
2086
|
+
#
|
2087
|
+
# * Session terminates automatically if client fails to connect in
|
2088
|
+
# time
|
2089
|
+
#
|
2090
|
+
# For more information about the stream session lifecycle, see [Stream
|
2091
|
+
# sessions][2] in the *Amazon GameLift Streams Developer Guide*.
|
2092
|
+
#
|
2093
|
+
# Timeouts to be aware of that affect a stream session:
|
2094
|
+
#
|
2095
|
+
# * **Placement timeout**: The amount of time that Amazon GameLift
|
2096
|
+
# Streams has to find capacity for a stream request. Placement timeout
|
2097
|
+
# varies based on the capacity type used to fulfill your stream
|
2098
|
+
# request:
|
2099
|
+
#
|
2100
|
+
# * **Always-on capacity**: 75 seconds
|
2101
|
+
#
|
2102
|
+
# * **On-demand capacity**:
|
2103
|
+
#
|
2104
|
+
# * Linux/Proton runtimes: 90 seconds
|
2105
|
+
#
|
2106
|
+
# * Windows runtime: 10 minutes
|
2107
|
+
# * **Connection timeout**: The amount of time that Amazon GameLift
|
2108
|
+
# Streams waits for a client to connect to a stream session in
|
2109
|
+
# `ACTIVE` status, or reconnect to a stream session in
|
2110
|
+
# `PENDING_CLIENT_RECONNECTION` status, the latter of which occurs
|
2111
|
+
# when a client disconnects or loses connection from a stream session.
|
2112
|
+
# If no client connects before the timeout, Amazon GameLift Streams
|
2113
|
+
# terminates the stream session. This value is specified by
|
2114
|
+
# `ConnectionTimeoutSeconds` in the `StartStreamSession` parameters.
|
2115
|
+
#
|
2116
|
+
# * **Idle timeout**: A stream session will be terminated if no user
|
2117
|
+
# input has been received for 60 minutes.
|
2118
|
+
#
|
2119
|
+
# * **Maximum session length**: A stream session will be terminated
|
2120
|
+
# after this amount of time has elapsed since it started, regardless
|
2121
|
+
# of any existing client connections. This value is specified by
|
2122
|
+
# `SessionLengthSeconds` in the `StartStreamSession` parameters.
|
2123
|
+
#
|
2124
|
+
# To start a new stream session, specify a stream group ID and
|
2125
|
+
# application ID, along with the transport protocol and signal request
|
2126
|
+
# to use with the stream session.
|
2019
2127
|
#
|
2020
2128
|
# For stream groups that have multiple locations, provide a set of
|
2021
2129
|
# locations ordered by priority using a `Locations` parameter. Amazon
|
2022
2130
|
# GameLift Streams will start a single stream session in the next
|
2023
|
-
# available location. An application must be finished replicating
|
2131
|
+
# available location. An application must be finished replicating to a
|
2024
2132
|
# remote location before the remote location can host a stream.
|
2025
2133
|
#
|
2026
|
-
#
|
2027
|
-
#
|
2028
|
-
# Name (ARN) value to the stream session resource and sets the status to
|
2029
|
-
# `ACTIVATING`. During the stream preparation process, Amazon GameLift
|
2030
|
-
# Streams queues the request and searches for available stream capacity
|
2031
|
-
# to run the stream. This results in one of the following:
|
2032
|
-
#
|
2033
|
-
# * Amazon GameLift Streams identifies an available compute resource to
|
2034
|
-
# run the application content and start the stream. When the stream is
|
2035
|
-
# ready, the stream session's status changes to `ACTIVE` and includes
|
2036
|
-
# stream connection information. Provide the connection information to
|
2037
|
-
# the requesting client to join the stream session.
|
2038
|
-
#
|
2039
|
-
# * Amazon GameLift Streams doesn't identify an available resource
|
2040
|
-
# within a certain time, set by `ClientToken`. In this case, Amazon
|
2041
|
-
# GameLift Streams stops processing the request, and the stream
|
2042
|
-
# session object status changes to `ERROR` with status reason
|
2043
|
-
# `placementTimeout`.
|
2134
|
+
# To reconnect to a stream session after a client disconnects or loses
|
2135
|
+
# connection, use [CreateStreamSessionConnection][3].
|
2044
2136
|
#
|
2045
2137
|
#
|
2046
2138
|
#
|
2047
2139
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
|
2140
|
+
# [2]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/stream-sessions.html
|
2141
|
+
# [3]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html
|
2048
2142
|
#
|
2049
2143
|
# @option params [String] :client_token
|
2050
2144
|
# A unique identifier that represents a client request. The request is
|
@@ -2105,15 +2199,15 @@ module Aws::GameLiftStreams
|
|
2105
2199
|
#
|
2106
2200
|
# @option params [Array<String>] :locations
|
2107
2201
|
# A list of locations, in order of priority, where you want Amazon
|
2108
|
-
# GameLift Streams to start a stream from.
|
2109
|
-
# selects the location with the next available
|
2110
|
-
# single stream session in. If this value is empty,
|
2111
|
-
# Streams attempts to start a stream session in the
|
2202
|
+
# GameLift Streams to start a stream from. For example, `us-east-1`.
|
2203
|
+
# Amazon GameLift Streams selects the location with the next available
|
2204
|
+
# capacity to start a single stream session in. If this value is empty,
|
2205
|
+
# Amazon GameLift Streams attempts to start a stream session in the
|
2206
|
+
# primary location.
|
2112
2207
|
#
|
2113
|
-
#
|
2114
|
-
#
|
2115
|
-
#
|
2116
|
-
# Streams Developer Guide*.
|
2208
|
+
# For a complete list of locations that Amazon GameLift Streams
|
2209
|
+
# supports, refer to [Regions, quotas, and limitations][1] in the
|
2210
|
+
# *Amazon GameLift Streams Developer Guide*.
|
2117
2211
|
#
|
2118
2212
|
#
|
2119
2213
|
#
|
@@ -2121,16 +2215,17 @@ module Aws::GameLiftStreams
|
|
2121
2215
|
#
|
2122
2216
|
# @option params [Integer] :connection_timeout_seconds
|
2123
2217
|
# Length of time (in seconds) that Amazon GameLift Streams should wait
|
2124
|
-
# for a client to connect or reconnect to the stream session.
|
2125
|
-
#
|
2126
|
-
#
|
2127
|
-
#
|
2218
|
+
# for a client to connect or reconnect to the stream session. Applies to
|
2219
|
+
# both connection and reconnection scenarios. This time span starts when
|
2220
|
+
# the stream session reaches `ACTIVE` state. If no client connects
|
2221
|
+
# before the timeout, Amazon GameLift Streams terminates the stream
|
2222
|
+
# session. Default value is 120.
|
2128
2223
|
#
|
2129
2224
|
# @option params [Integer] :session_length_seconds
|
2130
|
-
# The maximum
|
2131
|
-
#
|
2132
|
-
#
|
2133
|
-
#
|
2225
|
+
# The maximum duration of a session. Amazon GameLift Streams will
|
2226
|
+
# automatically terminate a session after this amount of time has
|
2227
|
+
# elapsed, regardless of any existing client connections. Default value
|
2228
|
+
# is 43200 (12 hours).
|
2134
2229
|
#
|
2135
2230
|
# @option params [Array<String>] :additional_launch_args
|
2136
2231
|
# A list of CLI arguments that are sent to the streaming server when a
|
@@ -2491,13 +2586,15 @@ module Aws::GameLiftStreams
|
|
2491
2586
|
# * **Always-on**: The streaming capacity that is allocated and ready to
|
2492
2587
|
# handle stream requests without delay. You pay for this capacity
|
2493
2588
|
# whether it's in use or not. Best for quickest time from streaming
|
2494
|
-
# request to streaming session.
|
2589
|
+
# request to streaming session. Default is 1 when creating a stream
|
2590
|
+
# group or adding a location.
|
2495
2591
|
#
|
2496
2592
|
# * **On-demand**: The streaming capacity that Amazon GameLift Streams
|
2497
2593
|
# can allocate in response to stream requests, and then de-allocate
|
2498
2594
|
# when the session has terminated. This offers a cost control measure
|
2499
2595
|
# at the expense of a greater startup time (typically under 5
|
2500
|
-
# minutes).
|
2596
|
+
# minutes). Default is 0 when creating a stream group or adding a
|
2597
|
+
# location.
|
2501
2598
|
#
|
2502
2599
|
# To update a stream group, specify the stream group's Amazon Resource
|
2503
2600
|
# Name (ARN) and provide the new values. If the request is successful,
|
@@ -2521,6 +2618,31 @@ module Aws::GameLiftStreams
|
|
2521
2618
|
# @option params [String] :description
|
2522
2619
|
# A descriptive label for the stream group.
|
2523
2620
|
#
|
2621
|
+
# @option params [String] :default_application_identifier
|
2622
|
+
# The unique identifier of the Amazon GameLift Streams application that
|
2623
|
+
# you want to set as the default application in a stream group. The
|
2624
|
+
# application that you specify must be in `READY` status. The default
|
2625
|
+
# application is pre-cached on always-on compute resources, reducing
|
2626
|
+
# stream startup times. Other applications are automatically cached as
|
2627
|
+
# needed.
|
2628
|
+
#
|
2629
|
+
# Note that this parameter only sets the default application in a stream
|
2630
|
+
# group. To associate a new application to an existing stream group, you
|
2631
|
+
# must use [AssociateApplications][1].
|
2632
|
+
#
|
2633
|
+
# When you switch default applications in a stream group, it can take up
|
2634
|
+
# to a few hours for the new default application to be pre-cached.
|
2635
|
+
#
|
2636
|
+
# This value is an [Amazon Resource Name (ARN)][2] or ID that uniquely
|
2637
|
+
# identifies the application resource. Example ARN:
|
2638
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2639
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
2640
|
+
#
|
2641
|
+
#
|
2642
|
+
#
|
2643
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
|
2644
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2645
|
+
#
|
2524
2646
|
# @return [Types::UpdateStreamGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2525
2647
|
#
|
2526
2648
|
# * {Types::UpdateStreamGroupOutput#arn #arn} => String
|
@@ -2547,6 +2669,7 @@ module Aws::GameLiftStreams
|
|
2547
2669
|
# },
|
2548
2670
|
# ],
|
2549
2671
|
# description: "Description",
|
2672
|
+
# default_application_identifier: "Identifier",
|
2550
2673
|
# })
|
2551
2674
|
#
|
2552
2675
|
# @example Response structure
|
@@ -2599,7 +2722,7 @@ module Aws::GameLiftStreams
|
|
2599
2722
|
tracer: tracer
|
2600
2723
|
)
|
2601
2724
|
context[:gem_name] = 'aws-sdk-gameliftstreams'
|
2602
|
-
context[:gem_version] = '1.
|
2725
|
+
context[:gem_version] = '1.11.0'
|
2603
2726
|
Seahorse::Client::Request.new(handlers, context)
|
2604
2727
|
end
|
2605
2728
|
|
@@ -522,6 +522,7 @@ module Aws::GameLiftStreams
|
|
522
522
|
UpdateStreamGroupInput.add_member(:identifier, Shapes::ShapeRef.new(shape: Identifier, required: true, location: "uri", location_name: "Identifier"))
|
523
523
|
UpdateStreamGroupInput.add_member(:location_configurations, Shapes::ShapeRef.new(shape: LocationConfigurations, location_name: "LocationConfigurations"))
|
524
524
|
UpdateStreamGroupInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
525
|
+
UpdateStreamGroupInput.add_member(:default_application_identifier, Shapes::ShapeRef.new(shape: Identifier, location_name: "DefaultApplicationIdentifier"))
|
525
526
|
UpdateStreamGroupInput.struct_class = Types::UpdateStreamGroupInput
|
526
527
|
|
527
528
|
UpdateStreamGroupOutput.add_member(:arn, Shapes::ShapeRef.new(shape: Identifier, required: true, location_name: "Arn"))
|
@@ -70,21 +70,21 @@ module Aws::GameLiftStreams
|
|
70
70
|
#
|
71
71
|
# A location can be in one of the following states:
|
72
72
|
#
|
73
|
-
# *
|
73
|
+
# * `ACTIVATING`: Amazon GameLift Streams is preparing the location.
|
74
74
|
# You cannot stream from, scale the capacity of, or remove this
|
75
75
|
# location yet.
|
76
76
|
#
|
77
|
-
# *
|
77
|
+
# * `ACTIVE`: The location is provisioned with initial capacity. You
|
78
78
|
# can now stream from, scale the capacity of, or remove this
|
79
79
|
# location.
|
80
80
|
#
|
81
|
-
# *
|
82
|
-
# The StatusReason field describes the error. You can remove this
|
81
|
+
# * `ERROR`: Amazon GameLift Streams failed to set up this location.
|
82
|
+
# The `StatusReason` field describes the error. You can remove this
|
83
83
|
# location and try to add it again.
|
84
84
|
#
|
85
|
-
# *
|
86
|
-
# location.
|
87
|
-
# in this stream group.
|
85
|
+
# * `REMOVING`: Amazon GameLift Streams is working to remove this
|
86
|
+
# location. This will release all provisioned capacity for this
|
87
|
+
# location in this stream group.
|
88
88
|
# @return [Array<Types::LocationState>]
|
89
89
|
#
|
90
90
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AddStreamGroupLocationsOutput AWS API Documentation
|
@@ -626,23 +626,25 @@ module Aws::GameLiftStreams
|
|
626
626
|
#
|
627
627
|
# @!attribute [rw] default_application_identifier
|
628
628
|
# The unique identifier of the Amazon GameLift Streams application
|
629
|
-
# that you want to
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
# applications that are associated using AssociateApplications. If not
|
635
|
-
# set when creating a stream group, you will need to call
|
636
|
-
# AssociateApplications later, before you can start streaming.
|
629
|
+
# that you want to set as the default application in a stream group.
|
630
|
+
# The application that you specify must be in `READY` status. The
|
631
|
+
# default application is pre-cached on always-on compute resources,
|
632
|
+
# reducing stream startup times. Other applications are automatically
|
633
|
+
# cached as needed.
|
637
634
|
#
|
638
|
-
#
|
635
|
+
# If you do not link an application when you create a stream group,
|
636
|
+
# you will need to link one later, before you can start streaming,
|
637
|
+
# using [AssociateApplications][1].
|
638
|
+
#
|
639
|
+
# This value is an [Amazon Resource Name (ARN)][2] or ID that uniquely
|
639
640
|
# identifies the application resource. Example ARN:
|
640
641
|
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
641
642
|
# Example ID: `a-9ZY8X7Wv6`.
|
642
643
|
#
|
643
644
|
#
|
644
645
|
#
|
645
|
-
# [1]: https://docs.aws.amazon.com/
|
646
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
|
647
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
646
648
|
# @return [String]
|
647
649
|
#
|
648
650
|
# @!attribute [rw] location_configurations
|
@@ -716,21 +718,21 @@ module Aws::GameLiftStreams
|
|
716
718
|
#
|
717
719
|
# A location can be in one of the following states:
|
718
720
|
#
|
719
|
-
# *
|
721
|
+
# * `ACTIVATING`: Amazon GameLift Streams is preparing the location.
|
720
722
|
# You cannot stream from, scale the capacity of, or remove this
|
721
723
|
# location yet.
|
722
724
|
#
|
723
|
-
# *
|
725
|
+
# * `ACTIVE`: The location is provisioned with initial capacity. You
|
724
726
|
# can now stream from, scale the capacity of, or remove this
|
725
727
|
# location.
|
726
728
|
#
|
727
|
-
# *
|
728
|
-
# The StatusReason field describes the error. You can remove this
|
729
|
+
# * `ERROR`: Amazon GameLift Streams failed to set up this location.
|
730
|
+
# The `StatusReason` field describes the error. You can remove this
|
729
731
|
# location and try to add it again.
|
730
732
|
#
|
731
|
-
# *
|
732
|
-
# location.
|
733
|
-
# in this stream group.
|
733
|
+
# * `REMOVING`: Amazon GameLift Streams is working to remove this
|
734
|
+
# location. This will release all provisioned capacity for this
|
735
|
+
# location in this stream group.
|
734
736
|
# @return [Array<Types::LocationState>]
|
735
737
|
#
|
736
738
|
# @!attribute [rw] stream_class
|
@@ -914,8 +916,7 @@ module Aws::GameLiftStreams
|
|
914
916
|
# Example ID: `sg-1AB2C3De4`.
|
915
917
|
#
|
916
918
|
# The stream group that you want to run this stream session with. The
|
917
|
-
# stream group must be in `ACTIVE` status
|
918
|
-
# capacity.
|
919
|
+
# stream group must be in `ACTIVE` status.
|
919
920
|
#
|
920
921
|
#
|
921
922
|
#
|
@@ -1406,21 +1407,21 @@ module Aws::GameLiftStreams
|
|
1406
1407
|
#
|
1407
1408
|
# A location can be in one of the following states:
|
1408
1409
|
#
|
1409
|
-
# *
|
1410
|
+
# * `ACTIVATING`: Amazon GameLift Streams is preparing the location.
|
1410
1411
|
# You cannot stream from, scale the capacity of, or remove this
|
1411
1412
|
# location yet.
|
1412
1413
|
#
|
1413
|
-
# *
|
1414
|
+
# * `ACTIVE`: The location is provisioned with initial capacity. You
|
1414
1415
|
# can now stream from, scale the capacity of, or remove this
|
1415
1416
|
# location.
|
1416
1417
|
#
|
1417
|
-
# *
|
1418
|
-
# The StatusReason field describes the error. You can remove this
|
1418
|
+
# * `ERROR`: Amazon GameLift Streams failed to set up this location.
|
1419
|
+
# The `StatusReason` field describes the error. You can remove this
|
1419
1420
|
# location and try to add it again.
|
1420
1421
|
#
|
1421
|
-
# *
|
1422
|
-
# location.
|
1423
|
-
# in this stream group.
|
1422
|
+
# * `REMOVING`: Amazon GameLift Streams is working to remove this
|
1423
|
+
# location. This will release all provisioned capacity for this
|
1424
|
+
# location in this stream group.
|
1424
1425
|
# @return [Array<Types::LocationState>]
|
1425
1426
|
#
|
1426
1427
|
# @!attribute [rw] stream_class
|
@@ -1649,8 +1650,39 @@ module Aws::GameLiftStreams
|
|
1649
1650
|
# @return [String]
|
1650
1651
|
#
|
1651
1652
|
# @!attribute [rw] status
|
1652
|
-
# The current status of the stream session. A stream session
|
1653
|
-
#
|
1653
|
+
# The current status of the stream session. A stream session is ready
|
1654
|
+
# for a client to connect when in `ACTIVE` status.
|
1655
|
+
#
|
1656
|
+
# * `ACTIVATING`: The stream session is starting and preparing to
|
1657
|
+
# stream.
|
1658
|
+
#
|
1659
|
+
# * `ACTIVE`: The stream session is ready and waiting for a client
|
1660
|
+
# connection. A client has `ConnectionTimeoutSeconds` (specified in
|
1661
|
+
# `StartStreamSession`) from when the session reaches `ACTIVE` state
|
1662
|
+
# to establish a connection. If no client connects within this
|
1663
|
+
# timeframe, the session automatically terminates.
|
1664
|
+
#
|
1665
|
+
# * `CONNECTED`: The stream session has a connected client. A session
|
1666
|
+
# will automatically terminate if there is no user input for 60
|
1667
|
+
# minutes, or if the maximum length of a session specified by
|
1668
|
+
# `SessionLengthSeconds` in `StartStreamSession` is exceeded.
|
1669
|
+
#
|
1670
|
+
# * `ERROR`: The stream session failed to activate.
|
1671
|
+
#
|
1672
|
+
# * `PENDING_CLIENT_RECONNECTION`: A client has recently disconnected
|
1673
|
+
# and the stream session is waiting for the client to reconnect. A
|
1674
|
+
# client has `ConnectionTimeoutSeconds` (specified in
|
1675
|
+
# `StartStreamSession`) from when the session reaches
|
1676
|
+
# `PENDING_CLIENT_RECONNECTION` state to re-establish a connection.
|
1677
|
+
# If no client connects within this timeframe, the session
|
1678
|
+
# automatically terminates.
|
1679
|
+
#
|
1680
|
+
# * `RECONNECTING`: A client has initiated a reconnect to a session
|
1681
|
+
# that was in `PENDING_CLIENT_RECONNECTION` state.
|
1682
|
+
#
|
1683
|
+
# * `TERMINATING`: The stream session is ending.
|
1684
|
+
#
|
1685
|
+
# * `TERMINATED`: The stream session has ended.
|
1654
1686
|
# @return [String]
|
1655
1687
|
#
|
1656
1688
|
# @!attribute [rw] status_reason
|
@@ -1663,10 +1695,8 @@ module Aws::GameLiftStreams
|
|
1663
1695
|
# @return [String]
|
1664
1696
|
#
|
1665
1697
|
# @!attribute [rw] location
|
1666
|
-
# The location where Amazon GameLift Streams
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
# A location's name. For example, `us-east-1`. For a complete list of
|
1698
|
+
# The location where Amazon GameLift Streams hosts and streams your
|
1699
|
+
# application. For example, `us-east-1`. For a complete list of
|
1670
1700
|
# locations that Amazon GameLift Streams supports, refer to [Regions,
|
1671
1701
|
# quotas, and limitations][1] in the *Amazon GameLift Streams
|
1672
1702
|
# Developer Guide*.
|
@@ -1687,15 +1717,18 @@ module Aws::GameLiftStreams
|
|
1687
1717
|
# @return [String]
|
1688
1718
|
#
|
1689
1719
|
# @!attribute [rw] connection_timeout_seconds
|
1690
|
-
# The
|
1691
|
-
#
|
1692
|
-
#
|
1693
|
-
#
|
1720
|
+
# The length of time that Amazon GameLift Streams should wait for a
|
1721
|
+
# client to connect or reconnect to the stream session. This time span
|
1722
|
+
# starts when the stream session reaches `ACTIVE` or
|
1723
|
+
# `PENDING_CLIENT_RECONNECTION` state. If no client connects (or
|
1724
|
+
# reconnects) before the timeout, Amazon GameLift Streams terminates
|
1725
|
+
# the stream session.
|
1694
1726
|
# @return [Integer]
|
1695
1727
|
#
|
1696
1728
|
# @!attribute [rw] session_length_seconds
|
1697
|
-
# The
|
1698
|
-
# session
|
1729
|
+
# The maximum duration of a session. Amazon GameLift Streams will
|
1730
|
+
# automatically terminate a session after this amount of time has
|
1731
|
+
# elapsed, regardless of any existing client connections.
|
1699
1732
|
# @return [Integer]
|
1700
1733
|
#
|
1701
1734
|
# @!attribute [rw] additional_launch_args
|
@@ -1966,13 +1999,13 @@ module Aws::GameLiftStreams
|
|
1966
1999
|
#
|
1967
2000
|
# Exported files can be in one of the following states:
|
1968
2001
|
#
|
1969
|
-
# *
|
2002
|
+
# * `SUCCEEDED`: The exported files are successfully stored in an S3
|
1970
2003
|
# bucket.
|
1971
2004
|
#
|
1972
|
-
# *
|
1973
|
-
#
|
2005
|
+
# * `FAILED`: The session ended but Amazon GameLift Streams couldn't
|
2006
|
+
# collect and upload the files to S3.
|
1974
2007
|
#
|
1975
|
-
# *
|
2008
|
+
# * `PENDING`: Either the stream session is still in progress, or
|
1976
2009
|
# uploading the exported files to the S3 bucket is in progress.
|
1977
2010
|
# @return [String]
|
1978
2011
|
#
|
@@ -2089,14 +2122,16 @@ module Aws::GameLiftStreams
|
|
2089
2122
|
# The streaming capacity that is allocated and ready to handle stream
|
2090
2123
|
# requests without delay. You pay for this capacity whether it's in
|
2091
2124
|
# use or not. Best for quickest time from streaming request to
|
2092
|
-
# streaming session.
|
2125
|
+
# streaming session. Default is 1 when creating a stream group or
|
2126
|
+
# adding a location.
|
2093
2127
|
# @return [Integer]
|
2094
2128
|
#
|
2095
2129
|
# @!attribute [rw] on_demand_capacity
|
2096
2130
|
# The streaming capacity that Amazon GameLift Streams can allocate in
|
2097
2131
|
# response to stream requests, and then de-allocate when the session
|
2098
2132
|
# has terminated. This offers a cost control measure at the expense of
|
2099
|
-
# a greater startup time (typically under 5 minutes).
|
2133
|
+
# a greater startup time (typically under 5 minutes). Default is 0
|
2134
|
+
# when creating a stream group or adding a location.
|
2100
2135
|
# @return [Integer]
|
2101
2136
|
#
|
2102
2137
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/LocationConfiguration AWS API Documentation
|
@@ -2129,35 +2164,37 @@ module Aws::GameLiftStreams
|
|
2129
2164
|
#
|
2130
2165
|
# A location can be in one of the following states:
|
2131
2166
|
#
|
2132
|
-
# *
|
2167
|
+
# * `ACTIVATING`: Amazon GameLift Streams is preparing the location.
|
2133
2168
|
# You cannot stream from, scale the capacity of, or remove this
|
2134
2169
|
# location yet.
|
2135
2170
|
#
|
2136
|
-
# *
|
2171
|
+
# * `ACTIVE`: The location is provisioned with initial capacity. You
|
2137
2172
|
# can now stream from, scale the capacity of, or remove this
|
2138
2173
|
# location.
|
2139
2174
|
#
|
2140
|
-
# *
|
2141
|
-
# The StatusReason field describes the error. You can remove this
|
2175
|
+
# * `ERROR`: Amazon GameLift Streams failed to set up this location.
|
2176
|
+
# The `StatusReason` field describes the error. You can remove this
|
2142
2177
|
# location and try to add it again.
|
2143
2178
|
#
|
2144
|
-
# *
|
2145
|
-
# location.
|
2146
|
-
# in this stream group.
|
2179
|
+
# * `REMOVING`: Amazon GameLift Streams is working to remove this
|
2180
|
+
# location. This will release all provisioned capacity for this
|
2181
|
+
# location in this stream group.
|
2147
2182
|
# @return [String]
|
2148
2183
|
#
|
2149
2184
|
# @!attribute [rw] always_on_capacity
|
2150
2185
|
# The streaming capacity that is allocated and ready to handle stream
|
2151
2186
|
# requests without delay. You pay for this capacity whether it's in
|
2152
2187
|
# use or not. Best for quickest time from streaming request to
|
2153
|
-
# streaming session.
|
2188
|
+
# streaming session. Default is 1 when creating a stream group or
|
2189
|
+
# adding a location.
|
2154
2190
|
# @return [Integer]
|
2155
2191
|
#
|
2156
2192
|
# @!attribute [rw] on_demand_capacity
|
2157
2193
|
# The streaming capacity that Amazon GameLift Streams can allocate in
|
2158
2194
|
# response to stream requests, and then de-allocate when the session
|
2159
2195
|
# has terminated. This offers a cost control measure at the expense of
|
2160
|
-
# a greater startup time (typically under 5 minutes).
|
2196
|
+
# a greater startup time (typically under 5 minutes). Default is 0
|
2197
|
+
# when creating a stream group or adding a location.
|
2161
2198
|
# @return [Integer]
|
2162
2199
|
#
|
2163
2200
|
# @!attribute [rw] requested_capacity
|
@@ -2208,12 +2245,12 @@ module Aws::GameLiftStreams
|
|
2208
2245
|
# @return [String]
|
2209
2246
|
#
|
2210
2247
|
# @!attribute [rw] locations
|
2211
|
-
# A set of locations to remove this stream group.
|
2248
|
+
# A set of locations to remove this stream group. For example,
|
2249
|
+
# `us-east-1`.
|
2212
2250
|
#
|
2213
|
-
#
|
2214
|
-
#
|
2215
|
-
#
|
2216
|
-
# Streams Developer Guide*.
|
2251
|
+
# For a complete list of locations that Amazon GameLift Streams
|
2252
|
+
# supports, refer to [Regions, quotas, and limitations][1] in the
|
2253
|
+
# *Amazon GameLift Streams Developer Guide*.
|
2217
2254
|
#
|
2218
2255
|
#
|
2219
2256
|
#
|
@@ -2393,15 +2430,15 @@ module Aws::GameLiftStreams
|
|
2393
2430
|
#
|
2394
2431
|
# @!attribute [rw] locations
|
2395
2432
|
# A list of locations, in order of priority, where you want Amazon
|
2396
|
-
# GameLift Streams to start a stream from.
|
2397
|
-
# selects the location with the next available
|
2398
|
-
# single stream session in. If this value is
|
2399
|
-
# Streams attempts to start a stream session in
|
2400
|
-
#
|
2401
|
-
#
|
2402
|
-
# a complete list of locations that Amazon GameLift Streams
|
2403
|
-
# refer to [Regions, quotas, and limitations][1] in the
|
2404
|
-
# GameLift Streams Developer Guide*.
|
2433
|
+
# GameLift Streams to start a stream from. For example, `us-east-1`.
|
2434
|
+
# Amazon GameLift Streams selects the location with the next available
|
2435
|
+
# capacity to start a single stream session in. If this value is
|
2436
|
+
# empty, Amazon GameLift Streams attempts to start a stream session in
|
2437
|
+
# the primary location.
|
2438
|
+
#
|
2439
|
+
# For a complete list of locations that Amazon GameLift Streams
|
2440
|
+
# supports, refer to [Regions, quotas, and limitations][1] in the
|
2441
|
+
# *Amazon GameLift Streams Developer Guide*.
|
2405
2442
|
#
|
2406
2443
|
#
|
2407
2444
|
#
|
@@ -2410,18 +2447,18 @@ module Aws::GameLiftStreams
|
|
2410
2447
|
#
|
2411
2448
|
# @!attribute [rw] connection_timeout_seconds
|
2412
2449
|
# Length of time (in seconds) that Amazon GameLift Streams should wait
|
2413
|
-
# for a client to connect or reconnect to the stream session.
|
2414
|
-
#
|
2415
|
-
#
|
2416
|
-
#
|
2417
|
-
# 120.
|
2450
|
+
# for a client to connect or reconnect to the stream session. Applies
|
2451
|
+
# to both connection and reconnection scenarios. This time span starts
|
2452
|
+
# when the stream session reaches `ACTIVE` state. If no client
|
2453
|
+
# connects before the timeout, Amazon GameLift Streams terminates the
|
2454
|
+
# stream session. Default value is 120.
|
2418
2455
|
# @return [Integer]
|
2419
2456
|
#
|
2420
2457
|
# @!attribute [rw] session_length_seconds
|
2421
|
-
# The maximum
|
2422
|
-
#
|
2423
|
-
#
|
2424
|
-
#
|
2458
|
+
# The maximum duration of a session. Amazon GameLift Streams will
|
2459
|
+
# automatically terminate a session after this amount of time has
|
2460
|
+
# elapsed, regardless of any existing client connections. Default
|
2461
|
+
# value is 43200 (12 hours).
|
2425
2462
|
# @return [Integer]
|
2426
2463
|
#
|
2427
2464
|
# @!attribute [rw] additional_launch_args
|
@@ -2504,8 +2541,39 @@ module Aws::GameLiftStreams
|
|
2504
2541
|
# @return [String]
|
2505
2542
|
#
|
2506
2543
|
# @!attribute [rw] status
|
2507
|
-
# The current status of the stream session. A stream session
|
2508
|
-
#
|
2544
|
+
# The current status of the stream session. A stream session is ready
|
2545
|
+
# for a client to connect when in `ACTIVE` status.
|
2546
|
+
#
|
2547
|
+
# * `ACTIVATING`: The stream session is starting and preparing to
|
2548
|
+
# stream.
|
2549
|
+
#
|
2550
|
+
# * `ACTIVE`: The stream session is ready and waiting for a client
|
2551
|
+
# connection. A client has `ConnectionTimeoutSeconds` (specified in
|
2552
|
+
# `StartStreamSession`) from when the session reaches `ACTIVE` state
|
2553
|
+
# to establish a connection. If no client connects within this
|
2554
|
+
# timeframe, the session automatically terminates.
|
2555
|
+
#
|
2556
|
+
# * `CONNECTED`: The stream session has a connected client. A session
|
2557
|
+
# will automatically terminate if there is no user input for 60
|
2558
|
+
# minutes, or if the maximum length of a session specified by
|
2559
|
+
# `SessionLengthSeconds` in `StartStreamSession` is exceeded.
|
2560
|
+
#
|
2561
|
+
# * `ERROR`: The stream session failed to activate.
|
2562
|
+
#
|
2563
|
+
# * `PENDING_CLIENT_RECONNECTION`: A client has recently disconnected
|
2564
|
+
# and the stream session is waiting for the client to reconnect. A
|
2565
|
+
# client has `ConnectionTimeoutSeconds` (specified in
|
2566
|
+
# `StartStreamSession`) from when the session reaches
|
2567
|
+
# `PENDING_CLIENT_RECONNECTION` state to re-establish a connection.
|
2568
|
+
# If no client connects within this timeframe, the session
|
2569
|
+
# automatically terminates.
|
2570
|
+
#
|
2571
|
+
# * `RECONNECTING`: A client has initiated a reconnect to a session
|
2572
|
+
# that was in `PENDING_CLIENT_RECONNECTION` state.
|
2573
|
+
#
|
2574
|
+
# * `TERMINATING`: The stream session is ending.
|
2575
|
+
#
|
2576
|
+
# * `TERMINATED`: The stream session has ended.
|
2509
2577
|
# @return [String]
|
2510
2578
|
#
|
2511
2579
|
# @!attribute [rw] status_reason
|
@@ -2518,10 +2586,8 @@ module Aws::GameLiftStreams
|
|
2518
2586
|
# @return [String]
|
2519
2587
|
#
|
2520
2588
|
# @!attribute [rw] location
|
2521
|
-
# The location where Amazon GameLift Streams
|
2522
|
-
# application
|
2523
|
-
#
|
2524
|
-
# A location's name. For example, `us-east-1`. For a complete list of
|
2589
|
+
# The location where Amazon GameLift Streams hosts and streams your
|
2590
|
+
# application. For example, `us-east-1`. For a complete list of
|
2525
2591
|
# locations that Amazon GameLift Streams supports, refer to [Regions,
|
2526
2592
|
# quotas, and limitations][1] in the *Amazon GameLift Streams
|
2527
2593
|
# Developer Guide*.
|
@@ -2542,15 +2608,18 @@ module Aws::GameLiftStreams
|
|
2542
2608
|
# @return [String]
|
2543
2609
|
#
|
2544
2610
|
# @!attribute [rw] connection_timeout_seconds
|
2545
|
-
# The
|
2546
|
-
#
|
2547
|
-
#
|
2548
|
-
#
|
2611
|
+
# The length of time that Amazon GameLift Streams should wait for a
|
2612
|
+
# client to connect or reconnect to the stream session. This time span
|
2613
|
+
# starts when the stream session reaches `ACTIVE` or
|
2614
|
+
# `PENDING_CLIENT_RECONNECTION` state. If no client connects (or
|
2615
|
+
# reconnects) before the timeout, Amazon GameLift Streams terminates
|
2616
|
+
# the stream session.
|
2549
2617
|
# @return [Integer]
|
2550
2618
|
#
|
2551
2619
|
# @!attribute [rw] session_length_seconds
|
2552
|
-
# The
|
2553
|
-
# session
|
2620
|
+
# The maximum duration of a session. Amazon GameLift Streams will
|
2621
|
+
# automatically terminate a session after this amount of time has
|
2622
|
+
# elapsed, regardless of any existing client connections.
|
2554
2623
|
# @return [Integer]
|
2555
2624
|
#
|
2556
2625
|
# @!attribute [rw] additional_launch_args
|
@@ -2610,8 +2679,10 @@ module Aws::GameLiftStreams
|
|
2610
2679
|
# @return [Time]
|
2611
2680
|
#
|
2612
2681
|
# @!attribute [rw] application_arn
|
2613
|
-
#
|
2614
|
-
#
|
2682
|
+
# The application streaming in this session.
|
2683
|
+
#
|
2684
|
+
# This value is an [Amazon Resource Name (ARN)][1] that uniquely
|
2685
|
+
# identifies the application resource. Example ARN:
|
2615
2686
|
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2616
2687
|
#
|
2617
2688
|
#
|
@@ -2811,7 +2882,7 @@ module Aws::GameLiftStreams
|
|
2811
2882
|
include Aws::Structure
|
2812
2883
|
end
|
2813
2884
|
|
2814
|
-
# Describes
|
2885
|
+
# Describes an Amazon GameLift Streams stream session. To retrieve
|
2815
2886
|
# additional details for the stream session, call [GetStreamSession][1].
|
2816
2887
|
#
|
2817
2888
|
#
|
@@ -2834,27 +2905,38 @@ module Aws::GameLiftStreams
|
|
2834
2905
|
# @return [String]
|
2835
2906
|
#
|
2836
2907
|
# @!attribute [rw] status
|
2837
|
-
# The current status of the stream session resource.
|
2838
|
-
# include the following:
|
2908
|
+
# The current status of the stream session resource.
|
2839
2909
|
#
|
2840
2910
|
# * `ACTIVATING`: The stream session is starting and preparing to
|
2841
2911
|
# stream.
|
2842
2912
|
#
|
2843
|
-
# * `ACTIVE`: The stream session is ready
|
2844
|
-
#
|
2913
|
+
# * `ACTIVE`: The stream session is ready and waiting for a client
|
2914
|
+
# connection. A client has `ConnectionTimeoutSeconds` (specified in
|
2915
|
+
# `StartStreamSession`) from when the session reaches `ACTIVE` state
|
2916
|
+
# to establish a connection. If no client connects within this
|
2917
|
+
# timeframe, the session automatically terminates.
|
2918
|
+
#
|
2919
|
+
# * `CONNECTED`: The stream session has a connected client. A session
|
2920
|
+
# will automatically terminate if there is no user input for 60
|
2921
|
+
# minutes, or if the maximum length of a session specified by
|
2922
|
+
# `SessionLengthSeconds` in `StartStreamSession` is exceeded.
|
2923
|
+
#
|
2924
|
+
# * `ERROR`: The stream session failed to activate.
|
2845
2925
|
#
|
2846
|
-
# * `
|
2926
|
+
# * `PENDING_CLIENT_RECONNECTION`: A client has recently disconnected
|
2927
|
+
# and the stream session is waiting for the client to reconnect. A
|
2928
|
+
# client has `ConnectionTimeoutSeconds` (specified in
|
2929
|
+
# `StartStreamSession`) from when the session reaches
|
2930
|
+
# `PENDING_CLIENT_RECONNECTION` state to re-establish a connection.
|
2931
|
+
# If no client connects within this timeframe, the session
|
2932
|
+
# automatically terminates.
|
2847
2933
|
#
|
2848
|
-
# * `
|
2849
|
-
#
|
2850
|
-
# After a short time, if the client doesn't reconnect, the stream
|
2851
|
-
# session status transitions to `TERMINATED`.
|
2934
|
+
# * `RECONNECTING`: A client has initiated a reconnect to a session
|
2935
|
+
# that was in `PENDING_CLIENT_RECONNECTION` state.
|
2852
2936
|
#
|
2853
2937
|
# * `TERMINATING`: The stream session is ending.
|
2854
2938
|
#
|
2855
2939
|
# * `TERMINATED`: The stream session has ended.
|
2856
|
-
#
|
2857
|
-
# * `ERROR`: The stream session failed to activate.
|
2858
2940
|
# @return [String]
|
2859
2941
|
#
|
2860
2942
|
# @!attribute [rw] protocol
|
@@ -2888,10 +2970,8 @@ module Aws::GameLiftStreams
|
|
2888
2970
|
# @return [Types::ExportFilesMetadata]
|
2889
2971
|
#
|
2890
2972
|
# @!attribute [rw] location
|
2891
|
-
# The location where Amazon GameLift Streams
|
2892
|
-
#
|
2893
|
-
#
|
2894
|
-
# A location's name. For example, `us-east-1`. For a complete list of
|
2973
|
+
# The location where Amazon GameLift Streams hosts and streams your
|
2974
|
+
# application. For example, `us-east-1`. For a complete list of
|
2895
2975
|
# locations that Amazon GameLift Streams supports, refer to [Regions,
|
2896
2976
|
# quotas, and limitations][1] in the *Amazon GameLift Streams
|
2897
2977
|
# Developer Guide*.
|
@@ -3243,12 +3323,39 @@ module Aws::GameLiftStreams
|
|
3243
3323
|
# A descriptive label for the stream group.
|
3244
3324
|
# @return [String]
|
3245
3325
|
#
|
3326
|
+
# @!attribute [rw] default_application_identifier
|
3327
|
+
# The unique identifier of the Amazon GameLift Streams application
|
3328
|
+
# that you want to set as the default application in a stream group.
|
3329
|
+
# The application that you specify must be in `READY` status. The
|
3330
|
+
# default application is pre-cached on always-on compute resources,
|
3331
|
+
# reducing stream startup times. Other applications are automatically
|
3332
|
+
# cached as needed.
|
3333
|
+
#
|
3334
|
+
# Note that this parameter only sets the default application in a
|
3335
|
+
# stream group. To associate a new application to an existing stream
|
3336
|
+
# group, you must use [AssociateApplications][1].
|
3337
|
+
#
|
3338
|
+
# When you switch default applications in a stream group, it can take
|
3339
|
+
# up to a few hours for the new default application to be pre-cached.
|
3340
|
+
#
|
3341
|
+
# This value is an [Amazon Resource Name (ARN)][2] or ID that uniquely
|
3342
|
+
# identifies the application resource. Example ARN:
|
3343
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
3344
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
3345
|
+
#
|
3346
|
+
#
|
3347
|
+
#
|
3348
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html
|
3349
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
3350
|
+
# @return [String]
|
3351
|
+
#
|
3246
3352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateStreamGroupInput AWS API Documentation
|
3247
3353
|
#
|
3248
3354
|
class UpdateStreamGroupInput < Struct.new(
|
3249
3355
|
:identifier,
|
3250
3356
|
:location_configurations,
|
3251
|
-
:description
|
3357
|
+
:description,
|
3358
|
+
:default_application_identifier)
|
3252
3359
|
SENSITIVE = []
|
3253
3360
|
include Aws::Structure
|
3254
3361
|
end
|
@@ -3279,21 +3386,21 @@ module Aws::GameLiftStreams
|
|
3279
3386
|
#
|
3280
3387
|
# A location can be in one of the following states:
|
3281
3388
|
#
|
3282
|
-
# *
|
3389
|
+
# * `ACTIVATING`: Amazon GameLift Streams is preparing the location.
|
3283
3390
|
# You cannot stream from, scale the capacity of, or remove this
|
3284
3391
|
# location yet.
|
3285
3392
|
#
|
3286
|
-
# *
|
3393
|
+
# * `ACTIVE`: The location is provisioned with initial capacity. You
|
3287
3394
|
# can now stream from, scale the capacity of, or remove this
|
3288
3395
|
# location.
|
3289
3396
|
#
|
3290
|
-
# *
|
3291
|
-
# The StatusReason field describes the error. You can remove this
|
3397
|
+
# * `ERROR`: Amazon GameLift Streams failed to set up this location.
|
3398
|
+
# The `StatusReason` field describes the error. You can remove this
|
3292
3399
|
# location and try to add it again.
|
3293
3400
|
#
|
3294
|
-
# *
|
3295
|
-
# location.
|
3296
|
-
# in this stream group.
|
3401
|
+
# * `REMOVING`: Amazon GameLift Streams is working to remove this
|
3402
|
+
# location. This will release all provisioned capacity for this
|
3403
|
+
# location in this stream group.
|
3297
3404
|
# @return [Array<Types::LocationState>]
|
3298
3405
|
#
|
3299
3406
|
# @!attribute [rw] stream_class
|
data/sig/client.rbs
CHANGED
@@ -480,7 +480,8 @@ module Aws
|
|
480
480
|
on_demand_capacity: ::Integer?
|
481
481
|
},
|
482
482
|
],
|
483
|
-
?description: ::String
|
483
|
+
?description: ::String,
|
484
|
+
?default_application_identifier: ::String
|
484
485
|
) -> _UpdateStreamGroupResponseSuccess
|
485
486
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateStreamGroupResponseSuccess
|
486
487
|
|
data/sig/types.rbs
CHANGED
@@ -477,6 +477,7 @@ module Aws::GameLiftStreams
|
|
477
477
|
attr_accessor identifier: ::String
|
478
478
|
attr_accessor location_configurations: ::Array[Types::LocationConfiguration]
|
479
479
|
attr_accessor description: ::String
|
480
|
+
attr_accessor default_application_identifier: ::String
|
480
481
|
SENSITIVE: []
|
481
482
|
end
|
482
483
|
|