aws-sdk-gameliftstreams 1.4.0 → 1.5.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 +193 -123
- data/lib/aws-sdk-gameliftstreams/types.rb +291 -214
- data/lib/aws-sdk-gameliftstreams.rb +1 -1
- 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: d621368a81c194c3c15b4513eb8408b8b3634c8876493c64380581a681913a14
|
4
|
+
data.tar.gz: 90c9b8aea4ae03f12529552712e91de3798daad797bc97b9f286b3e49e3fc0d6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a8476fdcf140ec1c65a6aebeea9584820e55a4aa0dc24c0b817bc4679f3be2f86b1f647b0c7aa76b98e76d2ad3fea49c3ef7f640fb1acc87138608d0deb96045
|
7
|
+
data.tar.gz: ae26221d593b613331392807b7a1b7c6e3f8932954a9b76270f636314083d92217f5563fd9198da808b0982240457a9b382b798917ce87b30b8d7a0f25958332
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.5.0 (2025-06-10)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for Amazon GameLift Streams to address formatting errors, correct resource ID examples, and update links to other guides
|
8
|
+
|
4
9
|
1.4.0 (2025-06-02)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.5.0
|
@@ -485,8 +485,14 @@ module Aws::GameLiftStreams
|
|
485
485
|
# @option params [required, String] :identifier
|
486
486
|
# A stream group to add the specified locations to.
|
487
487
|
#
|
488
|
-
# This value is
|
489
|
-
# the stream group resource.
|
488
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
489
|
+
# identifies the stream group resource. Example ARN:
|
490
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
491
|
+
# Example ID: `sg-1AB2C3De4`.
|
492
|
+
#
|
493
|
+
#
|
494
|
+
#
|
495
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
490
496
|
#
|
491
497
|
# @option params [required, Array<Types::LocationConfiguration>] :location_configurations
|
492
498
|
# A set of one or more locations and the streaming capacity for each
|
@@ -545,9 +551,9 @@ module Aws::GameLiftStreams
|
|
545
551
|
# A set of applications to associate with the stream group.
|
546
552
|
#
|
547
553
|
# This value is a set of either [Amazon Resource Names (ARN)][1] or IDs
|
548
|
-
# that uniquely identify application resources.
|
549
|
-
#
|
550
|
-
#
|
554
|
+
# that uniquely identify application resources. Example ARN:
|
555
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
556
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
551
557
|
#
|
552
558
|
#
|
553
559
|
#
|
@@ -556,10 +562,10 @@ module Aws::GameLiftStreams
|
|
556
562
|
# @option params [required, String] :identifier
|
557
563
|
# A stream group to associate to the applications.
|
558
564
|
#
|
559
|
-
# This value is
|
560
|
-
# identifies the stream group resource.
|
561
|
-
#
|
562
|
-
#
|
565
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
566
|
+
# identifies the stream group resource. Example ARN:
|
567
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
568
|
+
# Example ID: `sg-1AB2C3De4`.
|
563
569
|
#
|
564
570
|
#
|
565
571
|
#
|
@@ -602,8 +608,8 @@ module Aws::GameLiftStreams
|
|
602
608
|
# Developer Guide.
|
603
609
|
#
|
604
610
|
# Make sure that your files in the Amazon S3 bucket are the correct
|
605
|
-
# version you want to use.
|
606
|
-
#
|
611
|
+
# version you want to use. If you change the files at a later time, you
|
612
|
+
# will need to create a new Amazon GameLift Streams application.
|
607
613
|
#
|
608
614
|
# If the request is successful, Amazon GameLift Streams begins to create
|
609
615
|
# an application and sets the status to `INITIALIZED`. When an
|
@@ -621,11 +627,16 @@ module Aws::GameLiftStreams
|
|
621
627
|
# `ApplicationLogPaths`.
|
622
628
|
#
|
623
629
|
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift Streams
|
624
|
-
# access to write the log files. For more information, see
|
625
|
-
#
|
630
|
+
# access to write the log files. For more information, see [Application
|
631
|
+
# log bucket permission policy][1] in the *Amazon GameLift Streams
|
632
|
+
# Developer Guide*.
|
626
633
|
#
|
627
634
|
# </note>
|
628
635
|
#
|
636
|
+
#
|
637
|
+
#
|
638
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
|
639
|
+
#
|
629
640
|
# @option params [Array<String>] :application_log_paths
|
630
641
|
# Locations of log files that your content generates during a stream
|
631
642
|
# session. Enter path values that are relative to the
|
@@ -787,31 +798,34 @@ module Aws::GameLiftStreams
|
|
787
798
|
#
|
788
799
|
# Stream capacity represents the number of concurrent streams that can
|
789
800
|
# be active at a time. You set stream capacity per location, per stream
|
790
|
-
# group. There are two types of capacity
|
801
|
+
# group. There are two types of capacity, always-on and on-demand:
|
791
802
|
#
|
792
803
|
# * **Always-on**: The streaming capacity that is allocated and ready to
|
793
804
|
# handle stream requests without delay. You pay for this capacity
|
794
805
|
# whether it's in use or not. Best for quickest time from streaming
|
795
|
-
# request to streaming session.
|
796
|
-
#
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
806
|
+
# request to streaming session.
|
807
|
+
#
|
808
|
+
# * **On-demand**: The streaming capacity that Amazon GameLift Streams
|
809
|
+
# can allocate in response to stream requests, and then de-allocate
|
810
|
+
# when the session has terminated. This offers a cost control measure
|
811
|
+
# at the expense of a greater startup time (typically under 5
|
812
|
+
# minutes).
|
813
|
+
#
|
814
|
+
# To adjust the capacity of any `ACTIVE` stream group, call
|
815
|
+
# [UpdateStreamGroup][1].
|
816
|
+
#
|
817
|
+
# If the request is successful, Amazon GameLift Streams begins creating
|
818
|
+
# the stream group. Amazon GameLift Streams assigns a unique ID to the
|
819
|
+
# stream group resource and sets the status to `ACTIVATING`. When the
|
820
|
+
# stream group reaches `ACTIVE` status, you can start stream sessions by
|
821
|
+
# using [StartStreamSession][2]. To check the stream group's status,
|
822
|
+
# call [GetStreamGroup][3].
|
823
|
+
#
|
813
824
|
#
|
814
|
-
#
|
825
|
+
#
|
826
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html
|
827
|
+
# [2]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html
|
828
|
+
# [3]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html
|
815
829
|
#
|
816
830
|
# @option params [String] :client_token
|
817
831
|
# A unique identifier that represents a client request. The request is
|
@@ -833,6 +847,15 @@ module Aws::GameLiftStreams
|
|
833
847
|
# stream group, you will need to call AssociateApplications later,
|
834
848
|
# before you can start streaming.
|
835
849
|
#
|
850
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
851
|
+
# identifies the application resource. Example ARN:
|
852
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
853
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
854
|
+
#
|
855
|
+
#
|
856
|
+
#
|
857
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
858
|
+
#
|
836
859
|
# @option params [required, String] :description
|
837
860
|
# A descriptive label for the stream group.
|
838
861
|
#
|
@@ -1038,9 +1061,9 @@ module Aws::GameLiftStreams
|
|
1038
1061
|
#
|
1039
1062
|
# @option params [required, String] :identifier
|
1040
1063
|
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1041
|
-
# stream group resource.
|
1042
|
-
#
|
1043
|
-
#
|
1064
|
+
# stream group resource. Example ARN:
|
1065
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1066
|
+
# Example ID: `sg-1AB2C3De4`.
|
1044
1067
|
#
|
1045
1068
|
# The stream group that you want to run this stream session with. The
|
1046
1069
|
# stream group must be in `ACTIVE` status and have idle stream capacity.
|
@@ -1056,9 +1079,13 @@ module Aws::GameLiftStreams
|
|
1056
1079
|
# same offer provided to `StartStreamSession`.
|
1057
1080
|
#
|
1058
1081
|
# @option params [required, String] :stream_session_identifier
|
1059
|
-
# [Amazon Resource Name (ARN)][1] that uniquely identifies the
|
1060
|
-
# session resource.
|
1061
|
-
#
|
1082
|
+
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1083
|
+
# stream session resource. Example ARN:
|
1084
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
|
1085
|
+
# Example ID: `ABC123def4567`.
|
1086
|
+
#
|
1087
|
+
# The stream session must be in `PENDING_CLIENT_RECONNECTION` or
|
1088
|
+
# `ACTIVE` status.
|
1062
1089
|
#
|
1063
1090
|
#
|
1064
1091
|
#
|
@@ -1125,9 +1152,9 @@ module Aws::GameLiftStreams
|
|
1125
1152
|
#
|
1126
1153
|
# @option params [required, String] :identifier
|
1127
1154
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1128
|
-
# application resource.
|
1129
|
-
#
|
1130
|
-
#
|
1155
|
+
# application resource. Example ARN:
|
1156
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
1157
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
1131
1158
|
#
|
1132
1159
|
#
|
1133
1160
|
#
|
@@ -1165,8 +1192,14 @@ module Aws::GameLiftStreams
|
|
1165
1192
|
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListStreamSessions.html
|
1166
1193
|
#
|
1167
1194
|
# @option params [required, String] :identifier
|
1168
|
-
#
|
1169
|
-
#
|
1195
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1196
|
+
# stream group resource. Example ARN:
|
1197
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1198
|
+
# Example ID: `sg-1AB2C3De4`.
|
1199
|
+
#
|
1200
|
+
#
|
1201
|
+
#
|
1202
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1170
1203
|
#
|
1171
1204
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1172
1205
|
#
|
@@ -1206,9 +1239,9 @@ module Aws::GameLiftStreams
|
|
1206
1239
|
# group.
|
1207
1240
|
#
|
1208
1241
|
# This value is a set of either [Amazon Resource Names (ARN)][1] or IDs
|
1209
|
-
# that uniquely identify application resources.
|
1210
|
-
#
|
1211
|
-
#
|
1242
|
+
# that uniquely identify application resources. Example ARN:
|
1243
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
1244
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
1212
1245
|
#
|
1213
1246
|
#
|
1214
1247
|
#
|
@@ -1218,9 +1251,9 @@ module Aws::GameLiftStreams
|
|
1218
1251
|
# A stream group to disassociate these applications from.
|
1219
1252
|
#
|
1220
1253
|
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1221
|
-
# identifies the stream group resource.
|
1222
|
-
#
|
1223
|
-
#
|
1254
|
+
# identifies the stream group resource. Example ARN:
|
1255
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1256
|
+
# Example ID: `sg-1AB2C3De4`.
|
1224
1257
|
#
|
1225
1258
|
#
|
1226
1259
|
#
|
@@ -1291,9 +1324,9 @@ module Aws::GameLiftStreams
|
|
1291
1324
|
#
|
1292
1325
|
# @option params [required, String] :identifier
|
1293
1326
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1294
|
-
# stream group resource.
|
1295
|
-
#
|
1296
|
-
#
|
1327
|
+
# stream group resource. Example ARN:
|
1328
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1329
|
+
# Example ID: `sg-1AB2C3De4`.
|
1297
1330
|
#
|
1298
1331
|
#
|
1299
1332
|
#
|
@@ -1307,18 +1340,20 @@ module Aws::GameLiftStreams
|
|
1307
1340
|
# `.zip` file extension.
|
1308
1341
|
#
|
1309
1342
|
# Example 1: If you provide an S3 URI called
|
1310
|
-
# `s3://
|
1311
|
-
# save the files at that location.
|
1343
|
+
# `s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip`, then
|
1344
|
+
# Amazon GameLift Streams will save the files at that location.
|
1312
1345
|
#
|
1313
1346
|
# Example 2: If you provide an S3 URI called
|
1314
|
-
# `s3://
|
1315
|
-
# Streams will save the files at
|
1316
|
-
# `s3://
|
1347
|
+
# `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/`,
|
1348
|
+
# then Amazon GameLift Streams will save the files at
|
1349
|
+
# `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip`
|
1317
1350
|
# or another similar name.
|
1318
1351
|
#
|
1319
1352
|
# @option params [required, String] :stream_session_identifier
|
1320
1353
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1321
|
-
# stream session resource.
|
1354
|
+
# stream session resource. Example ARN:
|
1355
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
|
1356
|
+
# Example ID: `ABC123def4567`.
|
1322
1357
|
#
|
1323
1358
|
#
|
1324
1359
|
#
|
@@ -1350,9 +1385,9 @@ module Aws::GameLiftStreams
|
|
1350
1385
|
#
|
1351
1386
|
# @option params [required, String] :identifier
|
1352
1387
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1353
|
-
# application resource.
|
1354
|
-
#
|
1355
|
-
#
|
1388
|
+
# application resource. Example ARN:
|
1389
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
1390
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
1356
1391
|
#
|
1357
1392
|
#
|
1358
1393
|
#
|
@@ -1424,8 +1459,14 @@ module Aws::GameLiftStreams
|
|
1424
1459
|
# the requested stream group.
|
1425
1460
|
#
|
1426
1461
|
# @option params [required, String] :identifier
|
1427
|
-
#
|
1428
|
-
#
|
1462
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1463
|
+
# stream group resource. Example ARN:
|
1464
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1465
|
+
# Example ID: `sg-1AB2C3De4`.
|
1466
|
+
#
|
1467
|
+
#
|
1468
|
+
#
|
1469
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1429
1470
|
#
|
1430
1471
|
# @return [Types::GetStreamGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1431
1472
|
#
|
@@ -1494,17 +1535,19 @@ module Aws::GameLiftStreams
|
|
1494
1535
|
# The stream group that runs this stream session.
|
1495
1536
|
#
|
1496
1537
|
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1497
|
-
# identifies the stream group resource.
|
1498
|
-
#
|
1499
|
-
#
|
1538
|
+
# identifies the stream group resource. Example ARN:
|
1539
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1540
|
+
# Example ID: `sg-1AB2C3De4`.
|
1500
1541
|
#
|
1501
1542
|
#
|
1502
1543
|
#
|
1503
1544
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1504
1545
|
#
|
1505
1546
|
# @option params [required, String] :stream_session_identifier
|
1506
|
-
# An [Amazon Resource Name (ARN)][1] that uniquely identifies the
|
1507
|
-
# session resource.
|
1547
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
1548
|
+
# stream session resource. Example ARN:
|
1549
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
|
1550
|
+
# Example ID: `ABC123def4567`.
|
1508
1551
|
#
|
1509
1552
|
#
|
1510
1553
|
#
|
@@ -1713,7 +1756,11 @@ module Aws::GameLiftStreams
|
|
1713
1756
|
# @option params [required, String] :identifier
|
1714
1757
|
# The unique identifier of a Amazon GameLift Streams stream group to
|
1715
1758
|
# retrieve the stream session for. You can use either the stream group
|
1716
|
-
# ID or the Amazon Resource Name (ARN).
|
1759
|
+
# ID or the [Amazon Resource Name (ARN)][1].
|
1760
|
+
#
|
1761
|
+
#
|
1762
|
+
#
|
1763
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1717
1764
|
#
|
1718
1765
|
# @option params [Integer] :max_results
|
1719
1766
|
# The number of results to return. Use this parameter with `NextToken`
|
@@ -1864,13 +1911,13 @@ module Aws::GameLiftStreams
|
|
1864
1911
|
# [2]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/
|
1865
1912
|
#
|
1866
1913
|
# @option params [required, String] :resource_arn
|
1867
|
-
# The
|
1868
|
-
# for. To get
|
1869
|
-
# operation for the resource.
|
1914
|
+
# The [Amazon Resource Name (ARN)][1] that you want to retrieve tags
|
1915
|
+
# for. To get an Amazon GameLift Streams resource ARN, call a List or
|
1916
|
+
# Get operation for the resource.
|
1870
1917
|
#
|
1871
1918
|
#
|
1872
1919
|
#
|
1873
|
-
# [1]: https://docs.aws.amazon.com/
|
1920
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1874
1921
|
#
|
1875
1922
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1876
1923
|
#
|
@@ -1910,15 +1957,22 @@ module Aws::GameLiftStreams
|
|
1910
1957
|
# @option params [required, String] :identifier
|
1911
1958
|
# A stream group to remove the specified locations from.
|
1912
1959
|
#
|
1913
|
-
# This value is
|
1914
|
-
# the stream group resource.
|
1960
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1961
|
+
# identifies the stream group resource. Example ARN:
|
1962
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
1963
|
+
# Example ID: `sg-1AB2C3De4`.
|
1964
|
+
#
|
1965
|
+
#
|
1966
|
+
#
|
1967
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1915
1968
|
#
|
1916
1969
|
# @option params [required, Array<String>] :locations
|
1917
1970
|
# A set of locations to remove this stream group.
|
1918
1971
|
#
|
1919
1972
|
# A set of location names. For example, `us-east-1`. For a complete list
|
1920
|
-
# of locations that Amazon GameLift Streams supports, refer to [Regions
|
1921
|
-
# and
|
1973
|
+
# of locations that Amazon GameLift Streams supports, refer to [Regions,
|
1974
|
+
# quotas, and limitations][1] in the *Amazon GameLift Streams Developer
|
1975
|
+
# Guide*.
|
1922
1976
|
#
|
1923
1977
|
#
|
1924
1978
|
#
|
@@ -1946,8 +2000,7 @@ module Aws::GameLiftStreams
|
|
1946
2000
|
# information that clients can use to access the stream. A stream
|
1947
2001
|
# session refers to an instance of a stream that Amazon GameLift Streams
|
1948
2002
|
# transmits from the server to the end-user. A stream session runs on a
|
1949
|
-
# compute resource
|
1950
|
-
# allocated.
|
2003
|
+
# compute resource that a stream group has allocated.
|
1951
2004
|
#
|
1952
2005
|
# To start a new stream session, specify a stream group and application
|
1953
2006
|
# ID, along with the transport protocol and signal request settings to
|
@@ -1956,17 +2009,17 @@ module Aws::GameLiftStreams
|
|
1956
2009
|
# creating the stream group, or by using [AssociateApplications][1].
|
1957
2010
|
#
|
1958
2011
|
# For stream groups that have multiple locations, provide a set of
|
1959
|
-
# locations ordered by priority
|
1960
|
-
# Streams will start a single stream session in the next
|
1961
|
-
# location. An application must be finished replicating in a
|
1962
|
-
# location before the remote location can host a stream.
|
2012
|
+
# locations ordered by priority using a `Locations` parameter. Amazon
|
2013
|
+
# GameLift Streams will start a single stream session in the next
|
2014
|
+
# available location. An application must be finished replicating in a
|
2015
|
+
# remote location before the remote location can host a stream.
|
1963
2016
|
#
|
1964
2017
|
# If the request is successful, Amazon GameLift Streams begins to
|
1965
2018
|
# prepare the stream. Amazon GameLift Streams assigns an Amazon Resource
|
1966
2019
|
# Name (ARN) value to the stream session resource and sets the status to
|
1967
2020
|
# `ACTIVATING`. During the stream preparation process, Amazon GameLift
|
1968
2021
|
# Streams queues the request and searches for available stream capacity
|
1969
|
-
# to run the stream. This
|
2022
|
+
# to run the stream. This results in one of the following:
|
1970
2023
|
#
|
1971
2024
|
# * Amazon GameLift Streams identifies an available compute resource to
|
1972
2025
|
# run the application content and start the stream. When the stream is
|
@@ -2016,9 +2069,9 @@ module Aws::GameLiftStreams
|
|
2016
2069
|
#
|
2017
2070
|
# @option params [required, String] :application_identifier
|
2018
2071
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2019
|
-
# application resource.
|
2020
|
-
#
|
2021
|
-
#
|
2072
|
+
# application resource. Example ARN:
|
2073
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2074
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
2022
2075
|
#
|
2023
2076
|
#
|
2024
2077
|
#
|
@@ -2048,9 +2101,9 @@ module Aws::GameLiftStreams
|
|
2048
2101
|
# The stream group to run this stream session with.
|
2049
2102
|
#
|
2050
2103
|
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
2051
|
-
# identifies the stream group resource.
|
2052
|
-
#
|
2053
|
-
#
|
2104
|
+
# identifies the stream group resource. Example ARN:
|
2105
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
2106
|
+
# Example ID: `sg-1AB2C3De4`.
|
2054
2107
|
#
|
2055
2108
|
#
|
2056
2109
|
#
|
@@ -2065,8 +2118,8 @@ module Aws::GameLiftStreams
|
|
2065
2118
|
#
|
2066
2119
|
# This value is A set of location names. For example, `us-east-1`. For a
|
2067
2120
|
# complete list of locations that Amazon GameLift Streams supports,
|
2068
|
-
# refer to [Regions and
|
2069
|
-
# Developer Guide*.
|
2121
|
+
# refer to [Regions, quotas, and limitations][1] in the *Amazon GameLift
|
2122
|
+
# Streams Developer Guide*.
|
2070
2123
|
#
|
2071
2124
|
#
|
2072
2125
|
#
|
@@ -2083,8 +2136,18 @@ module Aws::GameLiftStreams
|
|
2083
2136
|
#
|
2084
2137
|
# @option params [required, String] :signal_request
|
2085
2138
|
# A WebRTC ICE offer string to use when initializing a WebRTC
|
2086
|
-
# connection.
|
2087
|
-
# as a text value in quotes.
|
2139
|
+
# connection. Typically, the offer is a very long JSON string. Provide
|
2140
|
+
# the string as a text value in quotes.
|
2141
|
+
#
|
2142
|
+
# Amazon GameLift Streams also supports setting the field to
|
2143
|
+
# "NO\_CLIENT\_CONNECTION". This will create a session without needing
|
2144
|
+
# any browser request or Web SDK integration. The session starts up as
|
2145
|
+
# usual and waits for a reconnection from a browser, which is
|
2146
|
+
# accomplished using [CreateStreamSessionConnection][1].
|
2147
|
+
#
|
2148
|
+
#
|
2149
|
+
#
|
2150
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html
|
2088
2151
|
#
|
2089
2152
|
# @option params [String] :user_id
|
2090
2153
|
# An opaque, unique identifier for an end-user, defined by the
|
@@ -2195,7 +2258,7 @@ module Aws::GameLiftStreams
|
|
2195
2258
|
#
|
2196
2259
|
#
|
2197
2260
|
#
|
2198
|
-
# [1]: https://docs.aws.amazon.com/
|
2261
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2199
2262
|
#
|
2200
2263
|
# @option params [required, Hash<String,String>] :tags
|
2201
2264
|
# A list of tags, in the form of key-value pairs, to assign to the
|
@@ -2228,9 +2291,9 @@ module Aws::GameLiftStreams
|
|
2228
2291
|
#
|
2229
2292
|
# @option params [required, String] :identifier
|
2230
2293
|
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2231
|
-
# stream group resource.
|
2232
|
-
#
|
2233
|
-
#
|
2294
|
+
# stream group resource. Example ARN:
|
2295
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
2296
|
+
# Example ID: `sg-1AB2C3De4`.
|
2234
2297
|
#
|
2235
2298
|
# The stream group that runs this stream session.
|
2236
2299
|
#
|
@@ -2239,8 +2302,10 @@ module Aws::GameLiftStreams
|
|
2239
2302
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2240
2303
|
#
|
2241
2304
|
# @option params [required, String] :stream_session_identifier
|
2242
|
-
# [Amazon Resource Name (ARN)][1] that uniquely identifies the
|
2243
|
-
# session resource.
|
2305
|
+
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2306
|
+
# stream session resource. Example ARN:
|
2307
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
|
2308
|
+
# Example ID: `ABC123def4567`.
|
2244
2309
|
#
|
2245
2310
|
#
|
2246
2311
|
#
|
@@ -2274,7 +2339,7 @@ module Aws::GameLiftStreams
|
|
2274
2339
|
#
|
2275
2340
|
#
|
2276
2341
|
#
|
2277
|
-
# [1]: https://docs.aws.amazon.com/
|
2342
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2278
2343
|
#
|
2279
2344
|
# @option params [required, Array<String>] :tag_keys
|
2280
2345
|
# A list of tag keys to remove from the specified Amazon GameLift
|
@@ -2312,11 +2377,16 @@ module Aws::GameLiftStreams
|
|
2312
2377
|
# `ApplicationLogPaths`.
|
2313
2378
|
#
|
2314
2379
|
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift Streams
|
2315
|
-
# access to write the log files. For more information, see
|
2316
|
-
#
|
2380
|
+
# access to write the log files. For more information, see [Application
|
2381
|
+
# log bucket permission policy][1] in the *Amazon GameLift Streams
|
2382
|
+
# Developer Guide*.
|
2317
2383
|
#
|
2318
2384
|
# </note>
|
2319
2385
|
#
|
2386
|
+
#
|
2387
|
+
#
|
2388
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
|
2389
|
+
#
|
2320
2390
|
# @option params [Array<String>] :application_log_paths
|
2321
2391
|
# Locations of log files that your content generates during a stream
|
2322
2392
|
# session. Enter path values that are relative to the
|
@@ -2335,9 +2405,9 @@ module Aws::GameLiftStreams
|
|
2335
2405
|
#
|
2336
2406
|
# @option params [required, String] :identifier
|
2337
2407
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2338
|
-
# application resource.
|
2339
|
-
#
|
2340
|
-
#
|
2408
|
+
# application resource. Example ARN:
|
2409
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
2410
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
2341
2411
|
#
|
2342
2412
|
#
|
2343
2413
|
#
|
@@ -2407,32 +2477,32 @@ module Aws::GameLiftStreams
|
|
2407
2477
|
#
|
2408
2478
|
# Stream capacity represents the number of concurrent streams that can
|
2409
2479
|
# be active at a time. You set stream capacity per location, per stream
|
2410
|
-
# group. There are two types of capacity
|
2480
|
+
# group. There are two types of capacity, always-on and on-demand:
|
2411
2481
|
#
|
2412
2482
|
# * **Always-on**: The streaming capacity that is allocated and ready to
|
2413
2483
|
# handle stream requests without delay. You pay for this capacity
|
2414
2484
|
# whether it's in use or not. Best for quickest time from streaming
|
2415
|
-
# request to streaming session.
|
2416
|
-
# <b>On-demand</b>: The streaming capacity that Amazon GameLift
|
2417
|
-
# Streams can allocate in response to stream requests, and then
|
2418
|
-
# de-allocate when the session has terminated. This offers a cost
|
2419
|
-
# control measure at the expense of a greater startup time (typically
|
2420
|
-
# under 5 minutes). </p> </li> </ul> <p>To update a stream group,
|
2421
|
-
# specify the stream group's Amazon Resource Name (ARN) and provide
|
2422
|
-
# the new values. If the request is successful, Amazon GameLift
|
2423
|
-
# Streams returns the complete updated metadata for the stream
|
2424
|
-
# group.</p>
|
2485
|
+
# request to streaming session.
|
2425
2486
|
#
|
2426
|
-
#
|
2487
|
+
# * **On-demand**: The streaming capacity that Amazon GameLift Streams
|
2488
|
+
# can allocate in response to stream requests, and then de-allocate
|
2489
|
+
# when the session has terminated. This offers a cost control measure
|
2490
|
+
# at the expense of a greater startup time (typically under 5
|
2491
|
+
# minutes).
|
2492
|
+
#
|
2493
|
+
# To update a stream group, specify the stream group's Amazon Resource
|
2494
|
+
# Name (ARN) and provide the new values. If the request is successful,
|
2495
|
+
# Amazon GameLift Streams returns the complete updated metadata for the
|
2496
|
+
# stream group.
|
2427
2497
|
#
|
2428
2498
|
# @option params [String] :description
|
2429
2499
|
# A descriptive label for the stream group.
|
2430
2500
|
#
|
2431
2501
|
# @option params [required, String] :identifier
|
2432
2502
|
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2433
|
-
# stream group resource.
|
2434
|
-
#
|
2435
|
-
#
|
2503
|
+
# stream group resource. Example ARN:
|
2504
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
2505
|
+
# Example ID: `sg-1AB2C3De4`.
|
2436
2506
|
#
|
2437
2507
|
#
|
2438
2508
|
#
|
@@ -2520,7 +2590,7 @@ module Aws::GameLiftStreams
|
|
2520
2590
|
tracer: tracer
|
2521
2591
|
)
|
2522
2592
|
context[:gem_name] = 'aws-sdk-gameliftstreams'
|
2523
|
-
context[:gem_version] = '1.
|
2593
|
+
context[:gem_version] = '1.5.0'
|
2524
2594
|
Seahorse::Client::Request.new(handlers, context)
|
2525
2595
|
end
|
2526
2596
|
|