aws-sdk-gameliftstreams 1.4.0 → 1.6.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.
@@ -95,7 +95,7 @@ module Aws::GameLiftStreams
95
95
  # class name or an instance of a plugin class.
96
96
  #
97
97
  # @option options [required, Aws::CredentialProvider] :credentials
98
- # Your AWS credentials. This can be an instance of any one of the
98
+ # Your AWS credentials used for authentication. This can be an instance of any one of the
99
99
  # following classes:
100
100
  #
101
101
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +128,23 @@ module Aws::GameLiftStreams
128
128
  # locations will be searched for credentials:
129
129
  #
130
130
  # * `Aws.config[:credentials]`
131
+ #
131
132
  # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
133
  # `:account_id` options.
133
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
- # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
134
+ #
135
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
136
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
137
+ #
135
138
  # * `~/.aws/credentials`
139
+ #
136
140
  # * `~/.aws/config`
141
+ #
137
142
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
143
  # are very aggressive. Construct and pass an instance of
139
144
  # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
145
  # enable retries and extended timeouts. Instance profile credential
141
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
- # to true.
146
+ # fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
147
+ # to `true`.
143
148
  #
144
149
  # @option options [required, String] :region
145
150
  # The AWS region to connect to. The configured `:region` is
@@ -167,6 +172,11 @@ module Aws::GameLiftStreams
167
172
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
173
  # not retry instead of sleeping.
169
174
  #
175
+ # @option options [Array<String>] :auth_scheme_preference
176
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
177
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
178
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
179
+ #
170
180
  # @option options [Boolean] :client_side_monitoring (false)
171
181
  # When `true`, client-side metrics will be collected for all API requests from
172
182
  # this client.
@@ -253,8 +263,8 @@ module Aws::GameLiftStreams
253
263
  # 4 times. Used in `standard` and `adaptive` retry modes.
254
264
  #
255
265
  # @option options [String] :profile ("default")
256
- # Used when loading credentials from the shared credentials file
257
- # at HOME/.aws/credentials. When not specified, 'default' is used.
266
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
267
+ # When not specified, 'default' is used.
258
268
  #
259
269
  # @option options [String] :request_checksum_calculation ("when_supported")
260
270
  # Determines when a checksum will be calculated for request payloads. Values are:
@@ -367,7 +377,7 @@ module Aws::GameLiftStreams
367
377
  # `Aws::Telemetry::OTelProvider` for telemetry provider.
368
378
  #
369
379
  # @option options [Aws::TokenProvider] :token_provider
370
- # A Bearer Token Provider. This can be an instance of any one of the
380
+ # Your Bearer token used for authentication. This can be an instance of any one of the
371
381
  # following classes:
372
382
  #
373
383
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -485,8 +495,14 @@ module Aws::GameLiftStreams
485
495
  # @option params [required, String] :identifier
486
496
  # A stream group to add the specified locations to.
487
497
  #
488
- # This value is a Amazon Resource Name (ARN) that uniquely identifies
489
- # the stream group resource. Format example: `sg-1AB2C3De4`.
498
+ # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
499
+ # identifies the stream group resource. Example ARN:
500
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
501
+ # Example ID: `sg-1AB2C3De4`.
502
+ #
503
+ #
504
+ #
505
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
490
506
  #
491
507
  # @option params [required, Array<Types::LocationConfiguration>] :location_configurations
492
508
  # A set of one or more locations and the streaming capacity for each
@@ -545,9 +561,9 @@ module Aws::GameLiftStreams
545
561
  # A set of applications to associate with the stream group.
546
562
  #
547
563
  # This value is a set of either [Amazon Resource Names (ARN)][1] or IDs
548
- # that uniquely identify application resources. Format example:
549
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`
550
- # or ID-`a-9ZY8X7Wv6`.
564
+ # that uniquely identify application resources. Example ARN:
565
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
566
+ # Example ID: `a-9ZY8X7Wv6`.
551
567
  #
552
568
  #
553
569
  #
@@ -556,10 +572,10 @@ module Aws::GameLiftStreams
556
572
  # @option params [required, String] :identifier
557
573
  # A stream group to associate to the applications.
558
574
  #
559
- # This value is a [Amazon Resource Name (ARN)][1] or ID that uniquely
560
- # identifies the stream group resource. Format example:
561
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
562
- # or ID-`sg-1AB2C3De4`.
575
+ # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
576
+ # identifies the stream group resource. Example ARN:
577
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
578
+ # Example ID: `sg-1AB2C3De4`.
563
579
  #
564
580
  #
565
581
  #
@@ -602,8 +618,8 @@ module Aws::GameLiftStreams
602
618
  # Developer Guide.
603
619
  #
604
620
  # Make sure that your files in the Amazon S3 bucket are the correct
605
- # version you want to use. As soon as you create a Amazon GameLift
606
- # Streams application, you cannot change the files at a later time.
621
+ # version you want to use. If you change the files at a later time, you
622
+ # will need to create a new Amazon GameLift Streams application.
607
623
  #
608
624
  # If the request is successful, Amazon GameLift Streams begins to create
609
625
  # an application and sets the status to `INITIALIZED`. When an
@@ -621,11 +637,16 @@ module Aws::GameLiftStreams
621
637
  # `ApplicationLogPaths`.
622
638
  #
623
639
  # <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 **Getting
625
- # Started** in the Amazon GameLift Streams Developer Guide.
640
+ # access to write the log files. For more information, see [Application
641
+ # log bucket permission policy][1] in the *Amazon GameLift Streams
642
+ # Developer Guide*.
626
643
  #
627
644
  # </note>
628
645
  #
646
+ #
647
+ #
648
+ # [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
649
+ #
629
650
  # @option params [Array<String>] :application_log_paths
630
651
  # Locations of log files that your content generates during a stream
631
652
  # session. Enter path values that are relative to the
@@ -787,31 +808,34 @@ module Aws::GameLiftStreams
787
808
  #
788
809
  # Stream capacity represents the number of concurrent streams that can
789
810
  # be active at a time. You set stream capacity per location, per stream
790
- # group. There are two types of capacity: always-on and on-demand:
811
+ # group. There are two types of capacity, always-on and on-demand:
791
812
  #
792
813
  # * **Always-on**: The streaming capacity that is allocated and ready to
793
814
  # handle stream requests without delay. You pay for this capacity
794
815
  # whether it's in use or not. Best for quickest time from streaming
795
- # request to streaming session. </p> </li> <li> <p>
796
- # <b>On-demand</b>: The streaming capacity that Amazon GameLift
797
- # Streams can allocate in response to stream requests, and then
798
- # de-allocate when the session has terminated. This offers a cost
799
- # control measure at the expense of a greater startup time (typically
800
- # under 5 minutes). </p> </li> </ul> <p> To adjust the capacity of any
801
- # <code>ACTIVE</code> stream group, call <a
802
- # href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a>.
803
- # </p> <p> If the request is successful, Amazon GameLift Streams
804
- # begins creating the stream group. Amazon GameLift Streams assigns a
805
- # unique ID to the stream group resource and sets the status to
806
- # <code>ACTIVATING</code>. When the stream group reaches
807
- # <code>ACTIVE</code> status, you can start stream sessions by using
808
- # <a
809
- # href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html">StartStreamSession</a>.
810
- # To check the stream group's status, call <a
811
- # href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>.
812
- # </p>
816
+ # request to streaming session.
813
817
  #
814
- # ^
818
+ # * **On-demand**: The streaming capacity that Amazon GameLift Streams
819
+ # can allocate in response to stream requests, and then de-allocate
820
+ # when the session has terminated. This offers a cost control measure
821
+ # at the expense of a greater startup time (typically under 5
822
+ # minutes).
823
+ #
824
+ # To adjust the capacity of any `ACTIVE` stream group, call
825
+ # [UpdateStreamGroup][1].
826
+ #
827
+ # If the request is successful, Amazon GameLift Streams begins creating
828
+ # the stream group. Amazon GameLift Streams assigns a unique ID to the
829
+ # stream group resource and sets the status to `ACTIVATING`. When the
830
+ # stream group reaches `ACTIVE` status, you can start stream sessions by
831
+ # using [StartStreamSession][2]. To check the stream group's status,
832
+ # call [GetStreamGroup][3].
833
+ #
834
+ #
835
+ #
836
+ # [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html
837
+ # [2]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html
838
+ # [3]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html
815
839
  #
816
840
  # @option params [String] :client_token
817
841
  # A unique identifier that represents a client request. The request is
@@ -833,6 +857,15 @@ module Aws::GameLiftStreams
833
857
  # stream group, you will need to call AssociateApplications later,
834
858
  # before you can start streaming.
835
859
  #
860
+ # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
861
+ # identifies the application resource. Example ARN:
862
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
863
+ # Example ID: `a-9ZY8X7Wv6`.
864
+ #
865
+ #
866
+ #
867
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
868
+ #
836
869
  # @option params [required, String] :description
837
870
  # A descriptive label for the stream group.
838
871
  #
@@ -1038,9 +1071,9 @@ module Aws::GameLiftStreams
1038
1071
  #
1039
1072
  # @option params [required, String] :identifier
1040
1073
  # [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1041
- # stream group resource. Format example:
1042
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
1043
- # or ID-`sg-1AB2C3De4`.
1074
+ # stream group resource. Example ARN:
1075
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1076
+ # Example ID: `sg-1AB2C3De4`.
1044
1077
  #
1045
1078
  # The stream group that you want to run this stream session with. The
1046
1079
  # stream group must be in `ACTIVE` status and have idle stream capacity.
@@ -1056,9 +1089,13 @@ module Aws::GameLiftStreams
1056
1089
  # same offer provided to `StartStreamSession`.
1057
1090
  #
1058
1091
  # @option params [required, String] :stream_session_identifier
1059
- # [Amazon Resource Name (ARN)][1] that uniquely identifies the stream
1060
- # session resource. Format example: `1AB2C3De4`. The stream session must
1061
- # be in `PENDING_CLIENT_RECONNECTION` or `ACTIVE` status.
1092
+ # [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1093
+ # stream session resource. Example ARN:
1094
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
1095
+ # Example ID: `ABC123def4567`.
1096
+ #
1097
+ # The stream session must be in `PENDING_CLIENT_RECONNECTION` or
1098
+ # `ACTIVE` status.
1062
1099
  #
1063
1100
  #
1064
1101
  #
@@ -1125,9 +1162,9 @@ module Aws::GameLiftStreams
1125
1162
  #
1126
1163
  # @option params [required, String] :identifier
1127
1164
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1128
- # application resource. Format example:
1129
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`
1130
- # or ID-`a-9ZY8X7Wv6`.
1165
+ # application resource. Example ARN:
1166
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
1167
+ # Example ID: `a-9ZY8X7Wv6`.
1131
1168
  #
1132
1169
  #
1133
1170
  #
@@ -1165,8 +1202,14 @@ module Aws::GameLiftStreams
1165
1202
  # [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListStreamSessions.html
1166
1203
  #
1167
1204
  # @option params [required, String] :identifier
1168
- # The unique ID value of the stream group resource to delete. Format
1169
- # example: `sg-1AB2C3De4`.
1205
+ # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1206
+ # stream group resource. Example ARN:
1207
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1208
+ # Example ID: `sg-1AB2C3De4`.
1209
+ #
1210
+ #
1211
+ #
1212
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
1170
1213
  #
1171
1214
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1172
1215
  #
@@ -1206,9 +1249,9 @@ module Aws::GameLiftStreams
1206
1249
  # group.
1207
1250
  #
1208
1251
  # This value is a set of either [Amazon Resource Names (ARN)][1] or IDs
1209
- # that uniquely identify application resources. Format example:
1210
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`
1211
- # or ID-`a-9ZY8X7Wv6`.
1252
+ # that uniquely identify application resources. Example ARN:
1253
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
1254
+ # Example ID: `a-9ZY8X7Wv6`.
1212
1255
  #
1213
1256
  #
1214
1257
  #
@@ -1218,9 +1261,9 @@ module Aws::GameLiftStreams
1218
1261
  # A stream group to disassociate these applications from.
1219
1262
  #
1220
1263
  # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
1221
- # identifies the stream group resource. Format example:
1222
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
1223
- # or ID-`sg-1AB2C3De4`.
1264
+ # identifies the stream group resource. Example ARN:
1265
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1266
+ # Example ID: `sg-1AB2C3De4`.
1224
1267
  #
1225
1268
  #
1226
1269
  #
@@ -1291,9 +1334,9 @@ module Aws::GameLiftStreams
1291
1334
  #
1292
1335
  # @option params [required, String] :identifier
1293
1336
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1294
- # stream group resource. Format example:
1295
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
1296
- # or ID-`sg-1AB2C3De4`.
1337
+ # stream group resource. Example ARN:
1338
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1339
+ # Example ID: `sg-1AB2C3De4`.
1297
1340
  #
1298
1341
  #
1299
1342
  #
@@ -1307,18 +1350,20 @@ module Aws::GameLiftStreams
1307
1350
  # `.zip` file extension.
1308
1351
  #
1309
1352
  # Example 1: If you provide an S3 URI called
1310
- # `s3://MyBucket/MyGame_Session1.zip`, then Amazon GameLift Streams will
1311
- # save the files at that location.
1353
+ # `s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip`, then
1354
+ # Amazon GameLift Streams will save the files at that location.
1312
1355
  #
1313
1356
  # Example 2: If you provide an S3 URI called
1314
- # `s3://MyBucket/MyGameSessions_ExportedFiles/`, then Amazon GameLift
1315
- # Streams will save the files at
1316
- # `s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip`
1357
+ # `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/`,
1358
+ # then Amazon GameLift Streams will save the files at
1359
+ # `s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip`
1317
1360
  # or another similar name.
1318
1361
  #
1319
1362
  # @option params [required, String] :stream_session_identifier
1320
1363
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1321
- # stream session resource. Format example: `1AB2C3De4`.
1364
+ # stream session resource. Example ARN:
1365
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
1366
+ # Example ID: `ABC123def4567`.
1322
1367
  #
1323
1368
  #
1324
1369
  #
@@ -1350,9 +1395,9 @@ module Aws::GameLiftStreams
1350
1395
  #
1351
1396
  # @option params [required, String] :identifier
1352
1397
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1353
- # application resource. Format example:
1354
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`
1355
- # or ID-`a-9ZY8X7Wv6`.
1398
+ # application resource. Example ARN:
1399
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
1400
+ # Example ID: `a-9ZY8X7Wv6`.
1356
1401
  #
1357
1402
  #
1358
1403
  #
@@ -1424,8 +1469,14 @@ module Aws::GameLiftStreams
1424
1469
  # the requested stream group.
1425
1470
  #
1426
1471
  # @option params [required, String] :identifier
1427
- # The unique ID value of the stream group resource to retrieve. Format
1428
- # example: `sg-1AB2C3De4`.
1472
+ # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1473
+ # stream group resource. Example ARN:
1474
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1475
+ # Example ID: `sg-1AB2C3De4`.
1476
+ #
1477
+ #
1478
+ #
1479
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
1429
1480
  #
1430
1481
  # @return [Types::GetStreamGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1431
1482
  #
@@ -1494,17 +1545,19 @@ module Aws::GameLiftStreams
1494
1545
  # The stream group that runs this stream session.
1495
1546
  #
1496
1547
  # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
1497
- # identifies the stream group resource. Format example:
1498
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
1499
- # or ID-`sg-1AB2C3De4`.
1548
+ # identifies the stream group resource. Example ARN:
1549
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1550
+ # Example ID: `sg-1AB2C3De4`.
1500
1551
  #
1501
1552
  #
1502
1553
  #
1503
1554
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
1504
1555
  #
1505
1556
  # @option params [required, String] :stream_session_identifier
1506
- # An [Amazon Resource Name (ARN)][1] that uniquely identifies the stream
1507
- # session resource. Format example: `1AB2C3De4`.
1557
+ # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
1558
+ # stream session resource. Example ARN:
1559
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
1560
+ # Example ID: `ABC123def4567`.
1508
1561
  #
1509
1562
  #
1510
1563
  #
@@ -1713,7 +1766,11 @@ module Aws::GameLiftStreams
1713
1766
  # @option params [required, String] :identifier
1714
1767
  # The unique identifier of a Amazon GameLift Streams stream group to
1715
1768
  # retrieve the stream session for. You can use either the stream group
1716
- # ID or the Amazon Resource Name (ARN).
1769
+ # ID or the [Amazon Resource Name (ARN)][1].
1770
+ #
1771
+ #
1772
+ #
1773
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
1717
1774
  #
1718
1775
  # @option params [Integer] :max_results
1719
1776
  # The number of results to return. Use this parameter with `NextToken`
@@ -1864,13 +1921,13 @@ module Aws::GameLiftStreams
1864
1921
  # [2]: http://aws.amazon.com/answers/account-management/aws-tagging-strategies/
1865
1922
  #
1866
1923
  # @option params [required, String] :resource_arn
1867
- # The ([Amazon Resource Name (ARN)][1] that you want to retrieve tags
1868
- # for. To get a Amazon GameLift Streams resource ARN, call a List or Get
1869
- # operation for the resource.
1924
+ # The [Amazon Resource Name (ARN)][1] that you want to retrieve tags
1925
+ # for. To get an Amazon GameLift Streams resource ARN, call a List or
1926
+ # Get operation for the resource.
1870
1927
  #
1871
1928
  #
1872
1929
  #
1873
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
1930
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
1874
1931
  #
1875
1932
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1876
1933
  #
@@ -1910,15 +1967,22 @@ module Aws::GameLiftStreams
1910
1967
  # @option params [required, String] :identifier
1911
1968
  # A stream group to remove the specified locations from.
1912
1969
  #
1913
- # This value is a Amazon Resource Name (ARN) that uniquely identifies
1914
- # the stream group resource. Format example: `sg-1AB2C3De4`.
1970
+ # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
1971
+ # identifies the stream group resource. Example ARN:
1972
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
1973
+ # Example ID: `sg-1AB2C3De4`.
1974
+ #
1975
+ #
1976
+ #
1977
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
1915
1978
  #
1916
1979
  # @option params [required, Array<String>] :locations
1917
1980
  # A set of locations to remove this stream group.
1918
1981
  #
1919
1982
  # 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 quotas][1] in the *Amazon GameLift Streams Developer Guide*.
1983
+ # of locations that Amazon GameLift Streams supports, refer to [Regions,
1984
+ # quotas, and limitations][1] in the *Amazon GameLift Streams Developer
1985
+ # Guide*.
1922
1986
  #
1923
1987
  #
1924
1988
  #
@@ -1946,8 +2010,7 @@ module Aws::GameLiftStreams
1946
2010
  # information that clients can use to access the stream. A stream
1947
2011
  # session refers to an instance of a stream that Amazon GameLift Streams
1948
2012
  # transmits from the server to the end-user. A stream session runs on a
1949
- # compute resource, or stream capacity, that a stream group has
1950
- # allocated.
2013
+ # compute resource that a stream group has allocated.
1951
2014
  #
1952
2015
  # To start a new stream session, specify a stream group and application
1953
2016
  # ID, along with the transport protocol and signal request settings to
@@ -1956,17 +2019,17 @@ module Aws::GameLiftStreams
1956
2019
  # creating the stream group, or by using [AssociateApplications][1].
1957
2020
  #
1958
2021
  # For stream groups that have multiple locations, provide a set of
1959
- # locations ordered by priority by setting `Locations`. Amazon GameLift
1960
- # Streams will start a single stream session in the next available
1961
- # location. An application must be finished replicating in a remote
1962
- # location before the remote location can host a stream.
2022
+ # locations ordered by priority using a `Locations` parameter. Amazon
2023
+ # GameLift Streams will start a single stream session in the next
2024
+ # available location. An application must be finished replicating in a
2025
+ # remote location before the remote location can host a stream.
1963
2026
  #
1964
2027
  # If the request is successful, Amazon GameLift Streams begins to
1965
2028
  # prepare the stream. Amazon GameLift Streams assigns an Amazon Resource
1966
2029
  # Name (ARN) value to the stream session resource and sets the status to
1967
2030
  # `ACTIVATING`. During the stream preparation process, Amazon GameLift
1968
2031
  # Streams queues the request and searches for available stream capacity
1969
- # to run the stream. This can result to one of the following:
2032
+ # to run the stream. This results in one of the following:
1970
2033
  #
1971
2034
  # * Amazon GameLift Streams identifies an available compute resource to
1972
2035
  # run the application content and start the stream. When the stream is
@@ -2016,9 +2079,9 @@ module Aws::GameLiftStreams
2016
2079
  #
2017
2080
  # @option params [required, String] :application_identifier
2018
2081
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
2019
- # application resource. Format example:
2020
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`
2021
- # or ID-`a-9ZY8X7Wv6`.
2082
+ # application resource. Example ARN:
2083
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
2084
+ # Example ID: `a-9ZY8X7Wv6`.
2022
2085
  #
2023
2086
  #
2024
2087
  #
@@ -2048,9 +2111,9 @@ module Aws::GameLiftStreams
2048
2111
  # The stream group to run this stream session with.
2049
2112
  #
2050
2113
  # This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
2051
- # identifies the stream group resource. Format example:
2052
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
2053
- # or ID-`sg-1AB2C3De4`.
2114
+ # identifies the stream group resource. Example ARN:
2115
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
2116
+ # Example ID: `sg-1AB2C3De4`.
2054
2117
  #
2055
2118
  #
2056
2119
  #
@@ -2065,8 +2128,8 @@ module Aws::GameLiftStreams
2065
2128
  #
2066
2129
  # This value is A set of location names. For example, `us-east-1`. For a
2067
2130
  # complete list of locations that Amazon GameLift Streams supports,
2068
- # refer to [Regions and quotas][1] in the *Amazon GameLift Streams
2069
- # Developer Guide*.
2131
+ # refer to [Regions, quotas, and limitations][1] in the *Amazon GameLift
2132
+ # Streams Developer Guide*.
2070
2133
  #
2071
2134
  #
2072
2135
  #
@@ -2083,8 +2146,18 @@ module Aws::GameLiftStreams
2083
2146
  #
2084
2147
  # @option params [required, String] :signal_request
2085
2148
  # A WebRTC ICE offer string to use when initializing a WebRTC
2086
- # connection. The offer is a very long JSON string. Provide the string
2087
- # as a text value in quotes.
2149
+ # connection. Typically, the offer is a very long JSON string. Provide
2150
+ # the string as a text value in quotes.
2151
+ #
2152
+ # Amazon GameLift Streams also supports setting the field to
2153
+ # "NO\_CLIENT\_CONNECTION". This will create a session without needing
2154
+ # any browser request or Web SDK integration. The session starts up as
2155
+ # usual and waits for a reconnection from a browser, which is
2156
+ # accomplished using [CreateStreamSessionConnection][1].
2157
+ #
2158
+ #
2159
+ #
2160
+ # [1]: https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html
2088
2161
  #
2089
2162
  # @option params [String] :user_id
2090
2163
  # An opaque, unique identifier for an end-user, defined by the
@@ -2195,7 +2268,7 @@ module Aws::GameLiftStreams
2195
2268
  #
2196
2269
  #
2197
2270
  #
2198
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
2271
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
2199
2272
  #
2200
2273
  # @option params [required, Hash<String,String>] :tags
2201
2274
  # A list of tags, in the form of key-value pairs, to assign to the
@@ -2228,9 +2301,9 @@ module Aws::GameLiftStreams
2228
2301
  #
2229
2302
  # @option params [required, String] :identifier
2230
2303
  # [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
2231
- # stream group resource. Format example:
2232
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
2233
- # or ID-`sg-1AB2C3De4`.
2304
+ # stream group resource. Example ARN:
2305
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
2306
+ # Example ID: `sg-1AB2C3De4`.
2234
2307
  #
2235
2308
  # The stream group that runs this stream session.
2236
2309
  #
@@ -2239,8 +2312,10 @@ module Aws::GameLiftStreams
2239
2312
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
2240
2313
  #
2241
2314
  # @option params [required, String] :stream_session_identifier
2242
- # [Amazon Resource Name (ARN)][1] that uniquely identifies the stream
2243
- # session resource. Format example: `1AB2C3De4`.
2315
+ # [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
2316
+ # stream session resource. Example ARN:
2317
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567`.
2318
+ # Example ID: `ABC123def4567`.
2244
2319
  #
2245
2320
  #
2246
2321
  #
@@ -2274,7 +2349,7 @@ module Aws::GameLiftStreams
2274
2349
  #
2275
2350
  #
2276
2351
  #
2277
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
2352
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
2278
2353
  #
2279
2354
  # @option params [required, Array<String>] :tag_keys
2280
2355
  # A list of tag keys to remove from the specified Amazon GameLift
@@ -2312,11 +2387,16 @@ module Aws::GameLiftStreams
2312
2387
  # `ApplicationLogPaths`.
2313
2388
  #
2314
2389
  # <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 **Getting
2316
- # Started** in the Amazon GameLift Streams Developer Guide.
2390
+ # access to write the log files. For more information, see [Application
2391
+ # log bucket permission policy][1] in the *Amazon GameLift Streams
2392
+ # Developer Guide*.
2317
2393
  #
2318
2394
  # </note>
2319
2395
  #
2396
+ #
2397
+ #
2398
+ # [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template
2399
+ #
2320
2400
  # @option params [Array<String>] :application_log_paths
2321
2401
  # Locations of log files that your content generates during a stream
2322
2402
  # session. Enter path values that are relative to the
@@ -2335,9 +2415,9 @@ module Aws::GameLiftStreams
2335
2415
  #
2336
2416
  # @option params [required, String] :identifier
2337
2417
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
2338
- # application resource. Format example:
2339
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6`
2340
- # or ID-`a-9ZY8X7Wv6`.
2418
+ # application resource. Example ARN:
2419
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
2420
+ # Example ID: `a-9ZY8X7Wv6`.
2341
2421
  #
2342
2422
  #
2343
2423
  #
@@ -2407,32 +2487,32 @@ module Aws::GameLiftStreams
2407
2487
  #
2408
2488
  # Stream capacity represents the number of concurrent streams that can
2409
2489
  # be active at a time. You set stream capacity per location, per stream
2410
- # group. There are two types of capacity: always-on and on-demand:
2490
+ # group. There are two types of capacity, always-on and on-demand:
2411
2491
  #
2412
2492
  # * **Always-on**: The streaming capacity that is allocated and ready to
2413
2493
  # handle stream requests without delay. You pay for this capacity
2414
2494
  # whether it's in use or not. Best for quickest time from streaming
2415
- # request to streaming session. </p> </li> <li> <p>
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>
2495
+ # request to streaming session.
2425
2496
  #
2426
- # ^
2497
+ # * **On-demand**: The streaming capacity that Amazon GameLift Streams
2498
+ # can allocate in response to stream requests, and then de-allocate
2499
+ # when the session has terminated. This offers a cost control measure
2500
+ # at the expense of a greater startup time (typically under 5
2501
+ # minutes).
2502
+ #
2503
+ # To update a stream group, specify the stream group's Amazon Resource
2504
+ # Name (ARN) and provide the new values. If the request is successful,
2505
+ # Amazon GameLift Streams returns the complete updated metadata for the
2506
+ # stream group.
2427
2507
  #
2428
2508
  # @option params [String] :description
2429
2509
  # A descriptive label for the stream group.
2430
2510
  #
2431
2511
  # @option params [required, String] :identifier
2432
2512
  # An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
2433
- # stream group resource. Format example:
2434
- # ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4`
2435
- # or ID-`sg-1AB2C3De4`.
2513
+ # stream group resource. Example ARN:
2514
+ # `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
2515
+ # Example ID: `sg-1AB2C3De4`.
2436
2516
  #
2437
2517
  #
2438
2518
  #
@@ -2520,7 +2600,7 @@ module Aws::GameLiftStreams
2520
2600
  tracer: tracer
2521
2601
  )
2522
2602
  context[:gem_name] = 'aws-sdk-gameliftstreams'
2523
- context[:gem_version] = '1.4.0'
2603
+ context[:gem_version] = '1.6.0'
2524
2604
  Seahorse::Client::Request.new(handlers, context)
2525
2605
  end
2526
2606