aws-sdk-gameliftstreams 1.33.0 → 1.34.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 +509 -1
- data/lib/aws-sdk-gameliftstreams/client_api.rb +204 -0
- data/lib/aws-sdk-gameliftstreams/types.rb +948 -16
- data/lib/aws-sdk-gameliftstreams.rb +1 -1
- data/sig/client.rbs +107 -0
- data/sig/types.rbs +128 -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: ef0e5d32d0d73e645fa328014ad1d8ecb4b7205aa1a41acd2234378a05bf5a46
|
|
4
|
+
data.tar.gz: 5329c004d13dfe753686e162bdddea7dd9aa8122bde729358b70cc30a9a760e8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d4e2208b234beb93f7445788314e9905cb4779310d0c9d8e18b8fd1ebcca7d3c1fd21fdf7c4d7a1aff9adce358e42b65ef36e423c9097900bbc4093ed738eedc
|
|
7
|
+
data.tar.gz: 347c261542dff003be22d187b485bf990b33c0725d1bd3d66e0f65c7bee073c2fbf37159ce31b565bb1af298565243e7253ce5991a420a9dcb622616593d6d38
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.34.0 (2026-07-29)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds ListApplicationShaderCaches API to retrieve shader cache metadata for applications and adds stream URLs, which give end users temporary, unauthenticated access to a stream session in their browser. Includes CreateStreamUrl, GetStreamUrl, ListStreamUrls, and RevokeStreamUrl operations.
|
|
8
|
+
|
|
4
9
|
1.33.0 (2026-07-23)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.34.0
|
|
@@ -1432,6 +1432,221 @@ module Aws::GameLiftStreams
|
|
|
1432
1432
|
req.send_request(options)
|
|
1433
1433
|
end
|
|
1434
1434
|
|
|
1435
|
+
# Creates a stream URL that grants temporary access to a stream session
|
|
1436
|
+
# in a web browser without requiring an Amazon Web Services account or
|
|
1437
|
+
# client integration.
|
|
1438
|
+
#
|
|
1439
|
+
# You can use the stream URL to start a stream session up to the number
|
|
1440
|
+
# of times set by `UsageLimit`, until it expires after
|
|
1441
|
+
# `UrlExpiresAfterMinutes`. Each successful use starts a new stream
|
|
1442
|
+
# session.
|
|
1443
|
+
#
|
|
1444
|
+
# To make the request idempotent, provide a `ClientToken`.
|
|
1445
|
+
#
|
|
1446
|
+
# @option params [required, String] :identifier
|
|
1447
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
|
1448
|
+
# stream group resource. Example ARN:
|
|
1449
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
|
1450
|
+
# Example ID: `sg-1AB2C3De4`.
|
|
1451
|
+
#
|
|
1452
|
+
# The stream session runs in this stream group.
|
|
1453
|
+
#
|
|
1454
|
+
#
|
|
1455
|
+
#
|
|
1456
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
|
1457
|
+
#
|
|
1458
|
+
# @option params [required, String] :application_identifier
|
|
1459
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
|
1460
|
+
# application resource. Example ARN:
|
|
1461
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
|
1462
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
|
1463
|
+
#
|
|
1464
|
+
# This application must be associated with the stream group.
|
|
1465
|
+
#
|
|
1466
|
+
#
|
|
1467
|
+
#
|
|
1468
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
|
1469
|
+
#
|
|
1470
|
+
# @option params [required, String] :protocol
|
|
1471
|
+
# The data transport protocol for the stream session. Amazon GameLift
|
|
1472
|
+
# Streams supports `WebRTC`.
|
|
1473
|
+
#
|
|
1474
|
+
# @option params [required, Integer] :url_expires_after_minutes
|
|
1475
|
+
# The number of minutes after creation that the stream URL remains
|
|
1476
|
+
# valid. After this period, the status of the stream URL changes to
|
|
1477
|
+
# `EXPIRED` and it can no longer start stream sessions. The minimum is 1
|
|
1478
|
+
# minute. For the maximum, see [Regions, quotas, and limitations][1] in
|
|
1479
|
+
# the *Amazon GameLift Streams Developer Guide*.
|
|
1480
|
+
#
|
|
1481
|
+
#
|
|
1482
|
+
#
|
|
1483
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
|
|
1484
|
+
#
|
|
1485
|
+
# @option params [Integer] :usage_limit
|
|
1486
|
+
# The maximum number of times the stream URL can start a stream session.
|
|
1487
|
+
# Each successful use reduces the remaining uses by one. The minimum is
|
|
1488
|
+
# 1, and the default is 1. For the maximum, see [Regions, quotas, and
|
|
1489
|
+
# limitations][1] in the *Amazon GameLift Streams Developer Guide*.
|
|
1490
|
+
#
|
|
1491
|
+
#
|
|
1492
|
+
#
|
|
1493
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
|
|
1494
|
+
#
|
|
1495
|
+
# @option params [String] :description
|
|
1496
|
+
# A descriptive label for the stream URL.
|
|
1497
|
+
#
|
|
1498
|
+
# @option params [required, Array<String>] :locations
|
|
1499
|
+
# A list of locations, in order of preference, where Amazon GameLift
|
|
1500
|
+
# Streams can place the stream session. Specify each location by its
|
|
1501
|
+
# Amazon Web Services Region code, for example `us-east-1`. For a
|
|
1502
|
+
# complete list of locations that Amazon GameLift Streams supports,
|
|
1503
|
+
# refer to [Regions, quotas, and limitations][1] in the *Amazon GameLift
|
|
1504
|
+
# Streams Developer Guide*.
|
|
1505
|
+
#
|
|
1506
|
+
#
|
|
1507
|
+
#
|
|
1508
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html
|
|
1509
|
+
#
|
|
1510
|
+
# @option params [Integer] :session_length_seconds
|
|
1511
|
+
# The maximum length of time, in seconds, that a stream session started
|
|
1512
|
+
# from this stream URL can run. Valid values are 1-86400 seconds (1
|
|
1513
|
+
# second to 24 hours). The default is 43200 seconds (12 hours).
|
|
1514
|
+
#
|
|
1515
|
+
# @option params [Array<String>] :additional_launch_args
|
|
1516
|
+
# A list of CLI arguments that are sent to the streaming server when a
|
|
1517
|
+
# stream session launches. You can use this to configure the application
|
|
1518
|
+
# or stream session details. You can also provide custom arguments that
|
|
1519
|
+
# Amazon GameLift Streams passes to your game client.
|
|
1520
|
+
#
|
|
1521
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
|
1522
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
|
1523
|
+
# environment variables; while `AdditionalLaunchArgs` passes data using
|
|
1524
|
+
# command-line arguments.
|
|
1525
|
+
#
|
|
1526
|
+
# @option params [Hash<String,String>] :additional_environment_variables
|
|
1527
|
+
# A set of options that you can use to control the stream session
|
|
1528
|
+
# runtime environment, expressed as a set of key-value pairs. You can
|
|
1529
|
+
# use this to configure the application or stream session details. You
|
|
1530
|
+
# can also provide custom environment variables that Amazon GameLift
|
|
1531
|
+
# Streams passes to your game client.
|
|
1532
|
+
#
|
|
1533
|
+
# <note markdown="1"> If you want to debug your application with environment variables, we
|
|
1534
|
+
# recommend that you do so in a local environment outside of Amazon
|
|
1535
|
+
# GameLift Streams. For more information, refer to the Compatibility
|
|
1536
|
+
# Guidance in the troubleshooting section of the Developer Guide.
|
|
1537
|
+
#
|
|
1538
|
+
# </note>
|
|
1539
|
+
#
|
|
1540
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
|
1541
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
|
1542
|
+
# environment variables; while `AdditionalLaunchArgs` passes data using
|
|
1543
|
+
# command-line arguments.
|
|
1544
|
+
#
|
|
1545
|
+
# @option params [String] :role_arn
|
|
1546
|
+
# The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift
|
|
1547
|
+
# Streams assumes during stream sessions started from this stream URL.
|
|
1548
|
+
# For more information, see [Provide AWS credentials to your streaming
|
|
1549
|
+
# application][1] in the *Amazon GameLift Streams Developer Guide*.
|
|
1550
|
+
#
|
|
1551
|
+
#
|
|
1552
|
+
#
|
|
1553
|
+
# [1]: https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/session-credentials.html
|
|
1554
|
+
#
|
|
1555
|
+
# @option params [Types::DisplayConfiguration] :display_configuration
|
|
1556
|
+
# The display settings, such as resolution, for stream sessions started
|
|
1557
|
+
# from this stream URL.
|
|
1558
|
+
#
|
|
1559
|
+
# @option params [String] :client_token
|
|
1560
|
+
# A unique, case-sensitive identifier that you provide to ensure this
|
|
1561
|
+
# request is idempotent. If you retry a request with the same
|
|
1562
|
+
# `ClientToken`, Amazon GameLift Streams returns the original response
|
|
1563
|
+
# without performing the operation again.
|
|
1564
|
+
#
|
|
1565
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1566
|
+
# not need to pass this option.**
|
|
1567
|
+
#
|
|
1568
|
+
# @return [Types::CreateStreamUrlOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1569
|
+
#
|
|
1570
|
+
# * {Types::CreateStreamUrlOutput#arn #arn} => String
|
|
1571
|
+
# * {Types::CreateStreamUrlOutput#stream_url_id #stream_url_id} => String
|
|
1572
|
+
# * {Types::CreateStreamUrlOutput#stream_url #stream_url} => String
|
|
1573
|
+
# * {Types::CreateStreamUrlOutput#status #status} => String
|
|
1574
|
+
# * {Types::CreateStreamUrlOutput#status_reason #status_reason} => String
|
|
1575
|
+
# * {Types::CreateStreamUrlOutput#expires_at #expires_at} => Time
|
|
1576
|
+
# * {Types::CreateStreamUrlOutput#created_at #created_at} => Time
|
|
1577
|
+
# * {Types::CreateStreamUrlOutput#usage_limit #usage_limit} => Integer
|
|
1578
|
+
# * {Types::CreateStreamUrlOutput#remaining_uses #remaining_uses} => Integer
|
|
1579
|
+
# * {Types::CreateStreamUrlOutput#stream_group_arn #stream_group_arn} => String
|
|
1580
|
+
# * {Types::CreateStreamUrlOutput#application_arn #application_arn} => String
|
|
1581
|
+
# * {Types::CreateStreamUrlOutput#protocol #protocol} => String
|
|
1582
|
+
# * {Types::CreateStreamUrlOutput#locations #locations} => Array<String>
|
|
1583
|
+
# * {Types::CreateStreamUrlOutput#session_length_seconds #session_length_seconds} => Integer
|
|
1584
|
+
# * {Types::CreateStreamUrlOutput#description #description} => String
|
|
1585
|
+
# * {Types::CreateStreamUrlOutput#additional_launch_args #additional_launch_args} => Array<String>
|
|
1586
|
+
# * {Types::CreateStreamUrlOutput#additional_environment_variables #additional_environment_variables} => Hash<String,String>
|
|
1587
|
+
# * {Types::CreateStreamUrlOutput#role_arn #role_arn} => String
|
|
1588
|
+
# * {Types::CreateStreamUrlOutput#display_configuration #display_configuration} => Types::DisplayConfiguration
|
|
1589
|
+
#
|
|
1590
|
+
# @example Request syntax with placeholder values
|
|
1591
|
+
#
|
|
1592
|
+
# resp = client.create_stream_url({
|
|
1593
|
+
# identifier: "Identifier", # required
|
|
1594
|
+
# application_identifier: "Identifier", # required
|
|
1595
|
+
# protocol: "WebRTC", # required, accepts WebRTC
|
|
1596
|
+
# url_expires_after_minutes: 1, # required
|
|
1597
|
+
# usage_limit: 1,
|
|
1598
|
+
# description: "Description",
|
|
1599
|
+
# locations: ["LocationName"], # required
|
|
1600
|
+
# session_length_seconds: 1,
|
|
1601
|
+
# additional_launch_args: ["String"],
|
|
1602
|
+
# additional_environment_variables: {
|
|
1603
|
+
# "EnvironmentVariablesKeyString" => "EnvironmentVariablesValueString",
|
|
1604
|
+
# },
|
|
1605
|
+
# role_arn: "IamRoleArn",
|
|
1606
|
+
# display_configuration: {
|
|
1607
|
+
# resolution: {
|
|
1608
|
+
# width: 1, # required
|
|
1609
|
+
# height: 1, # required
|
|
1610
|
+
# },
|
|
1611
|
+
# },
|
|
1612
|
+
# client_token: "ClientToken",
|
|
1613
|
+
# })
|
|
1614
|
+
#
|
|
1615
|
+
# @example Response structure
|
|
1616
|
+
#
|
|
1617
|
+
# resp.arn #=> String
|
|
1618
|
+
# resp.stream_url_id #=> String
|
|
1619
|
+
# resp.stream_url #=> String
|
|
1620
|
+
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "REVOKED", "LIMIT_REACHED"
|
|
1621
|
+
# resp.status_reason #=> String, one of "userRevoked", "revokedAndTerminatingSessions", "revokedAndSessionsTerminated", "streamGroupDeleted", "applicationDeleted"
|
|
1622
|
+
# resp.expires_at #=> Time
|
|
1623
|
+
# resp.created_at #=> Time
|
|
1624
|
+
# resp.usage_limit #=> Integer
|
|
1625
|
+
# resp.remaining_uses #=> Integer
|
|
1626
|
+
# resp.stream_group_arn #=> String
|
|
1627
|
+
# resp.application_arn #=> String
|
|
1628
|
+
# resp.protocol #=> String, one of "WebRTC"
|
|
1629
|
+
# resp.locations #=> Array
|
|
1630
|
+
# resp.locations[0] #=> String
|
|
1631
|
+
# resp.session_length_seconds #=> Integer
|
|
1632
|
+
# resp.description #=> String
|
|
1633
|
+
# resp.additional_launch_args #=> Array
|
|
1634
|
+
# resp.additional_launch_args[0] #=> String
|
|
1635
|
+
# resp.additional_environment_variables #=> Hash
|
|
1636
|
+
# resp.additional_environment_variables["EnvironmentVariablesKeyString"] #=> String
|
|
1637
|
+
# resp.role_arn #=> String
|
|
1638
|
+
# resp.display_configuration.resolution.width #=> Integer
|
|
1639
|
+
# resp.display_configuration.resolution.height #=> Integer
|
|
1640
|
+
#
|
|
1641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateStreamUrl AWS API Documentation
|
|
1642
|
+
#
|
|
1643
|
+
# @overload create_stream_url(params = {})
|
|
1644
|
+
# @param [Hash] params ({})
|
|
1645
|
+
def create_stream_url(params = {}, options = {})
|
|
1646
|
+
req = build_request(:create_stream_url, params)
|
|
1647
|
+
req.send_request(options)
|
|
1648
|
+
end
|
|
1649
|
+
|
|
1435
1650
|
# Permanently deletes an Amazon GameLift Streams application resource.
|
|
1436
1651
|
# This also deletes the application content files stored with Amazon
|
|
1437
1652
|
# GameLift Streams. However, this does not delete the original files
|
|
@@ -1960,6 +2175,156 @@ module Aws::GameLiftStreams
|
|
|
1960
2175
|
req.send_request(options)
|
|
1961
2176
|
end
|
|
1962
2177
|
|
|
2178
|
+
# Retrieves properties for a stream URL, including its current status,
|
|
2179
|
+
# usage, and the stream sessions started through it.
|
|
2180
|
+
#
|
|
2181
|
+
# If you delete the stream group or application that backs the stream
|
|
2182
|
+
# URL, this operation updates the status of the stream URL to `REVOKED`.
|
|
2183
|
+
#
|
|
2184
|
+
# @option params [required, String] :identifier
|
|
2185
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
|
2186
|
+
# stream group resource. Example ARN:
|
|
2187
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
|
2188
|
+
# Example ID: `sg-1AB2C3De4`.
|
|
2189
|
+
#
|
|
2190
|
+
# This is the stream group that owns the stream URL.
|
|
2191
|
+
#
|
|
2192
|
+
#
|
|
2193
|
+
#
|
|
2194
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
|
2195
|
+
#
|
|
2196
|
+
# @option params [required, String] :stream_url_identifier
|
|
2197
|
+
# The unique identifier of the stream URL. Specify a stream URL ID or
|
|
2198
|
+
# Amazon Resource Name (ARN). Example ARN:
|
|
2199
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4`.
|
|
2200
|
+
# Example ID: `su-1AB2C3De4`.
|
|
2201
|
+
#
|
|
2202
|
+
# @return [Types::GetStreamUrlOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2203
|
+
#
|
|
2204
|
+
# * {Types::GetStreamUrlOutput#arn #arn} => String
|
|
2205
|
+
# * {Types::GetStreamUrlOutput#stream_url_id #stream_url_id} => String
|
|
2206
|
+
# * {Types::GetStreamUrlOutput#stream_url #stream_url} => String
|
|
2207
|
+
# * {Types::GetStreamUrlOutput#status #status} => String
|
|
2208
|
+
# * {Types::GetStreamUrlOutput#status_reason #status_reason} => String
|
|
2209
|
+
# * {Types::GetStreamUrlOutput#expires_at #expires_at} => Time
|
|
2210
|
+
# * {Types::GetStreamUrlOutput#created_at #created_at} => Time
|
|
2211
|
+
# * {Types::GetStreamUrlOutput#usage_limit #usage_limit} => Integer
|
|
2212
|
+
# * {Types::GetStreamUrlOutput#remaining_uses #remaining_uses} => Integer
|
|
2213
|
+
# * {Types::GetStreamUrlOutput#stream_group_arn #stream_group_arn} => String
|
|
2214
|
+
# * {Types::GetStreamUrlOutput#application_arn #application_arn} => String
|
|
2215
|
+
# * {Types::GetStreamUrlOutput#protocol #protocol} => String
|
|
2216
|
+
# * {Types::GetStreamUrlOutput#locations #locations} => Array<String>
|
|
2217
|
+
# * {Types::GetStreamUrlOutput#session_length_seconds #session_length_seconds} => Integer
|
|
2218
|
+
# * {Types::GetStreamUrlOutput#description #description} => String
|
|
2219
|
+
# * {Types::GetStreamUrlOutput#additional_launch_args #additional_launch_args} => Array<String>
|
|
2220
|
+
# * {Types::GetStreamUrlOutput#additional_environment_variables #additional_environment_variables} => Hash<String,String>
|
|
2221
|
+
# * {Types::GetStreamUrlOutput#role_arn #role_arn} => String
|
|
2222
|
+
# * {Types::GetStreamUrlOutput#display_configuration #display_configuration} => Types::DisplayConfiguration
|
|
2223
|
+
# * {Types::GetStreamUrlOutput#stream_sessions #stream_sessions} => Array<Types::StreamSessionSummary>
|
|
2224
|
+
#
|
|
2225
|
+
# @example Request syntax with placeholder values
|
|
2226
|
+
#
|
|
2227
|
+
# resp = client.get_stream_url({
|
|
2228
|
+
# identifier: "Identifier", # required
|
|
2229
|
+
# stream_url_identifier: "Identifier", # required
|
|
2230
|
+
# })
|
|
2231
|
+
#
|
|
2232
|
+
# @example Response structure
|
|
2233
|
+
#
|
|
2234
|
+
# resp.arn #=> String
|
|
2235
|
+
# resp.stream_url_id #=> String
|
|
2236
|
+
# resp.stream_url #=> String
|
|
2237
|
+
# resp.status #=> String, one of "ACTIVE", "EXPIRED", "REVOKED", "LIMIT_REACHED"
|
|
2238
|
+
# resp.status_reason #=> String, one of "userRevoked", "revokedAndTerminatingSessions", "revokedAndSessionsTerminated", "streamGroupDeleted", "applicationDeleted"
|
|
2239
|
+
# resp.expires_at #=> Time
|
|
2240
|
+
# resp.created_at #=> Time
|
|
2241
|
+
# resp.usage_limit #=> Integer
|
|
2242
|
+
# resp.remaining_uses #=> Integer
|
|
2243
|
+
# resp.stream_group_arn #=> String
|
|
2244
|
+
# resp.application_arn #=> String
|
|
2245
|
+
# resp.protocol #=> String, one of "WebRTC"
|
|
2246
|
+
# resp.locations #=> Array
|
|
2247
|
+
# resp.locations[0] #=> String
|
|
2248
|
+
# resp.session_length_seconds #=> Integer
|
|
2249
|
+
# resp.description #=> String
|
|
2250
|
+
# resp.additional_launch_args #=> Array
|
|
2251
|
+
# resp.additional_launch_args[0] #=> String
|
|
2252
|
+
# resp.additional_environment_variables #=> Hash
|
|
2253
|
+
# resp.additional_environment_variables["EnvironmentVariablesKeyString"] #=> String
|
|
2254
|
+
# resp.role_arn #=> String
|
|
2255
|
+
# resp.display_configuration.resolution.width #=> Integer
|
|
2256
|
+
# resp.display_configuration.resolution.height #=> Integer
|
|
2257
|
+
# resp.stream_sessions #=> Array
|
|
2258
|
+
# resp.stream_sessions[0].arn #=> String
|
|
2259
|
+
# resp.stream_sessions[0].user_id #=> String
|
|
2260
|
+
# resp.stream_sessions[0].status #=> String, one of "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR"
|
|
2261
|
+
# resp.stream_sessions[0].status_reason #=> String, one of "internalError", "invalidSignalRequest", "placementTimeout", "applicationLogS3DestinationError", "assumeRoleFailed", "applicationExit", "connectionTimeout", "reconnectionTimeout", "maxSessionLengthTimeout", "idleTimeout", "apiTerminated"
|
|
2262
|
+
# resp.stream_sessions[0].protocol #=> String, one of "WebRTC"
|
|
2263
|
+
# resp.stream_sessions[0].last_updated_at #=> Time
|
|
2264
|
+
# resp.stream_sessions[0].created_at #=> Time
|
|
2265
|
+
# resp.stream_sessions[0].application_arn #=> String
|
|
2266
|
+
# resp.stream_sessions[0].export_files_metadata.status #=> String, one of "SUCCEEDED", "FAILED", "PENDING"
|
|
2267
|
+
# resp.stream_sessions[0].export_files_metadata.status_reason #=> String
|
|
2268
|
+
# resp.stream_sessions[0].export_files_metadata.output_uri #=> String
|
|
2269
|
+
# resp.stream_sessions[0].location #=> String
|
|
2270
|
+
# resp.stream_sessions[0].role_arn #=> String
|
|
2271
|
+
#
|
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetStreamUrl AWS API Documentation
|
|
2273
|
+
#
|
|
2274
|
+
# @overload get_stream_url(params = {})
|
|
2275
|
+
# @param [Hash] params ({})
|
|
2276
|
+
def get_stream_url(params = {}, options = {})
|
|
2277
|
+
req = build_request(:get_stream_url, params)
|
|
2278
|
+
req.send_request(options)
|
|
2279
|
+
end
|
|
2280
|
+
|
|
2281
|
+
# Lists the shader caches associated with an Amazon GameLift Streams
|
|
2282
|
+
# application. Each shader cache entry includes its status, associated
|
|
2283
|
+
# stream groups, and size in bytes.
|
|
2284
|
+
#
|
|
2285
|
+
# Returns shader caches associated with the specified Amazon GameLift
|
|
2286
|
+
# Streams application in all statuses.
|
|
2287
|
+
#
|
|
2288
|
+
# @option params [required, String] :identifier
|
|
2289
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
|
2290
|
+
# application resource. Example ARN:
|
|
2291
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`.
|
|
2292
|
+
# Example ID: `a-9ZY8X7Wv6`.
|
|
2293
|
+
#
|
|
2294
|
+
#
|
|
2295
|
+
#
|
|
2296
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
|
2297
|
+
#
|
|
2298
|
+
# @return [Types::ListApplicationShaderCachesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2299
|
+
#
|
|
2300
|
+
# * {Types::ListApplicationShaderCachesOutput#items #items} => Array<Types::ShaderCacheSummary>
|
|
2301
|
+
#
|
|
2302
|
+
# @example Request syntax with placeholder values
|
|
2303
|
+
#
|
|
2304
|
+
# resp = client.list_application_shader_caches({
|
|
2305
|
+
# identifier: "Identifier", # required
|
|
2306
|
+
# })
|
|
2307
|
+
#
|
|
2308
|
+
# @example Response structure
|
|
2309
|
+
#
|
|
2310
|
+
# resp.items #=> Array
|
|
2311
|
+
# resp.items[0].identifier #=> String
|
|
2312
|
+
# resp.items[0].application_arn #=> String
|
|
2313
|
+
# resp.items[0].status #=> String, one of "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR"
|
|
2314
|
+
# resp.items[0].last_updated_at #=> Time
|
|
2315
|
+
# resp.items[0].storage_bytes #=> Integer
|
|
2316
|
+
# resp.items[0].associated_stream_groups #=> Array
|
|
2317
|
+
# resp.items[0].associated_stream_groups[0] #=> String
|
|
2318
|
+
#
|
|
2319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListApplicationShaderCaches AWS API Documentation
|
|
2320
|
+
#
|
|
2321
|
+
# @overload list_application_shader_caches(params = {})
|
|
2322
|
+
# @param [Hash] params ({})
|
|
2323
|
+
def list_application_shader_caches(params = {}, options = {})
|
|
2324
|
+
req = build_request(:list_application_shader_caches, params)
|
|
2325
|
+
req.send_request(options)
|
|
2326
|
+
end
|
|
2327
|
+
|
|
1963
2328
|
# Retrieves a list of all Amazon GameLift Streams applications that are
|
|
1964
2329
|
# associated with the Amazon Web Services account in use. This operation
|
|
1965
2330
|
# returns applications in all statuses, in no particular order. You can
|
|
@@ -2236,6 +2601,93 @@ module Aws::GameLiftStreams
|
|
|
2236
2601
|
req.send_request(options)
|
|
2237
2602
|
end
|
|
2238
2603
|
|
|
2604
|
+
# Retrieves a list of the stream URLs in the current Amazon Web Services
|
|
2605
|
+
# Region for your Amazon Web Services account. You can filter the
|
|
2606
|
+
# results by status or by stream group. Use the pagination parameters to
|
|
2607
|
+
# retrieve results as a set of sequential pages. If you delete the
|
|
2608
|
+
# stream group or application that backs a stream URL, this operation
|
|
2609
|
+
# updates that stream URL's status to `REVOKED`.
|
|
2610
|
+
#
|
|
2611
|
+
# @option params [String] :status
|
|
2612
|
+
# Filters the list to stream URLs with the specified status.
|
|
2613
|
+
#
|
|
2614
|
+
# * `ACTIVE`: The stream URL is valid and can start stream sessions.
|
|
2615
|
+
#
|
|
2616
|
+
# * `EXPIRED`: The stream URL has passed its expiration time and can no
|
|
2617
|
+
# longer start stream sessions.
|
|
2618
|
+
#
|
|
2619
|
+
# * `REVOKED`: The stream URL was revoked and can no longer start stream
|
|
2620
|
+
# sessions.
|
|
2621
|
+
#
|
|
2622
|
+
# * `LIMIT_REACHED`: The stream URL has been used the maximum number of
|
|
2623
|
+
# times and can no longer start stream sessions.
|
|
2624
|
+
#
|
|
2625
|
+
# @option params [String] :stream_group_identifier
|
|
2626
|
+
# Filters the list to stream URLs that belong to the specified stream
|
|
2627
|
+
# group.
|
|
2628
|
+
#
|
|
2629
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
|
2630
|
+
# identifies the stream group resource. Example ARN:
|
|
2631
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
|
2632
|
+
# Example ID: `sg-1AB2C3De4`.
|
|
2633
|
+
#
|
|
2634
|
+
#
|
|
2635
|
+
#
|
|
2636
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
|
2637
|
+
#
|
|
2638
|
+
# @option params [String] :next_token
|
|
2639
|
+
# The token that marks the start of the next set of results. Use this
|
|
2640
|
+
# token when you retrieve results as sequential pages. To get the first
|
|
2641
|
+
# page of results, omit a token value. To get the remaining pages,
|
|
2642
|
+
# provide the token returned with the previous result set.
|
|
2643
|
+
#
|
|
2644
|
+
# @option params [Integer] :max_results
|
|
2645
|
+
# The maximum number of results to return per page. Valid values are
|
|
2646
|
+
# 1-100. The default is 25.
|
|
2647
|
+
#
|
|
2648
|
+
# @return [Types::ListStreamUrlsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2649
|
+
#
|
|
2650
|
+
# * {Types::ListStreamUrlsOutput#items #items} => Array<Types::StreamUrlSummary>
|
|
2651
|
+
# * {Types::ListStreamUrlsOutput#next_token #next_token} => String
|
|
2652
|
+
#
|
|
2653
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
2654
|
+
#
|
|
2655
|
+
# @example Request syntax with placeholder values
|
|
2656
|
+
#
|
|
2657
|
+
# resp = client.list_stream_urls({
|
|
2658
|
+
# status: "ACTIVE", # accepts ACTIVE, EXPIRED, REVOKED, LIMIT_REACHED
|
|
2659
|
+
# stream_group_identifier: "Identifier",
|
|
2660
|
+
# next_token: "NextToken",
|
|
2661
|
+
# max_results: 1,
|
|
2662
|
+
# })
|
|
2663
|
+
#
|
|
2664
|
+
# @example Response structure
|
|
2665
|
+
#
|
|
2666
|
+
# resp.items #=> Array
|
|
2667
|
+
# resp.items[0].arn #=> String
|
|
2668
|
+
# resp.items[0].stream_url_id #=> String
|
|
2669
|
+
# resp.items[0].stream_url #=> String
|
|
2670
|
+
# resp.items[0].status #=> String, one of "ACTIVE", "EXPIRED", "REVOKED", "LIMIT_REACHED"
|
|
2671
|
+
# resp.items[0].status_reason #=> String, one of "userRevoked", "revokedAndTerminatingSessions", "revokedAndSessionsTerminated", "streamGroupDeleted", "applicationDeleted"
|
|
2672
|
+
# resp.items[0].expires_at #=> Time
|
|
2673
|
+
# resp.items[0].created_at #=> Time
|
|
2674
|
+
# resp.items[0].usage_limit #=> Integer
|
|
2675
|
+
# resp.items[0].remaining_uses #=> Integer
|
|
2676
|
+
# resp.items[0].stream_group_arn #=> String
|
|
2677
|
+
# resp.items[0].application_arn #=> String
|
|
2678
|
+
# resp.items[0].session_length_seconds #=> Integer
|
|
2679
|
+
# resp.items[0].description #=> String
|
|
2680
|
+
# resp.next_token #=> String
|
|
2681
|
+
#
|
|
2682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamUrls AWS API Documentation
|
|
2683
|
+
#
|
|
2684
|
+
# @overload list_stream_urls(params = {})
|
|
2685
|
+
# @param [Hash] params ({})
|
|
2686
|
+
def list_stream_urls(params = {}, options = {})
|
|
2687
|
+
req = build_request(:list_stream_urls, params)
|
|
2688
|
+
req.send_request(options)
|
|
2689
|
+
end
|
|
2690
|
+
|
|
2239
2691
|
# Retrieves all tags assigned to a Amazon GameLift Streams resource. To
|
|
2240
2692
|
# list tags for a resource, specify the ARN value for the resource.
|
|
2241
2693
|
#
|
|
@@ -2339,6 +2791,62 @@ module Aws::GameLiftStreams
|
|
|
2339
2791
|
req.send_request(options)
|
|
2340
2792
|
end
|
|
2341
2793
|
|
|
2794
|
+
# Revokes a stream URL so that it can no longer start new stream
|
|
2795
|
+
# sessions. By default, stream sessions that are already running
|
|
2796
|
+
# continue until they end on their own. To also end running sessions,
|
|
2797
|
+
# set `RevocationMode` to `REVOKE_AND_TERMINATE_SESSIONS`.
|
|
2798
|
+
#
|
|
2799
|
+
# Revoking a stream URL is permanent. The status of the stream URL
|
|
2800
|
+
# changes to `REVOKED`.
|
|
2801
|
+
#
|
|
2802
|
+
# @option params [required, String] :identifier
|
|
2803
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
|
2804
|
+
# stream group resource. Example ARN:
|
|
2805
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4`.
|
|
2806
|
+
# Example ID: `sg-1AB2C3De4`.
|
|
2807
|
+
#
|
|
2808
|
+
# This is the stream group that owns the stream URL.
|
|
2809
|
+
#
|
|
2810
|
+
#
|
|
2811
|
+
#
|
|
2812
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
|
2813
|
+
#
|
|
2814
|
+
# @option params [required, String] :stream_url_identifier
|
|
2815
|
+
# The unique identifier of the stream URL to revoke. Specify a stream
|
|
2816
|
+
# URL ID or Amazon Resource Name (ARN). Example ARN:
|
|
2817
|
+
# `arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4`.
|
|
2818
|
+
# Example ID: `su-1AB2C3De4`.
|
|
2819
|
+
#
|
|
2820
|
+
# @option params [String] :revocation_mode
|
|
2821
|
+
# Controls what happens to running stream sessions when you revoke the
|
|
2822
|
+
# stream URL. If you do not specify a value, the default is
|
|
2823
|
+
# `REVOKE_URL`. Possible values include the following:
|
|
2824
|
+
#
|
|
2825
|
+
# * `REVOKE_URL`: Stops the stream URL from starting new stream
|
|
2826
|
+
# sessions. Running sessions continue until they end.
|
|
2827
|
+
#
|
|
2828
|
+
# * `REVOKE_AND_TERMINATE_SESSIONS`: Stops new stream sessions and ends
|
|
2829
|
+
# any running stream sessions.
|
|
2830
|
+
#
|
|
2831
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2832
|
+
#
|
|
2833
|
+
# @example Request syntax with placeholder values
|
|
2834
|
+
#
|
|
2835
|
+
# resp = client.revoke_stream_url({
|
|
2836
|
+
# identifier: "Identifier", # required
|
|
2837
|
+
# stream_url_identifier: "Identifier", # required
|
|
2838
|
+
# revocation_mode: "REVOKE_URL", # accepts REVOKE_URL, REVOKE_AND_TERMINATE_SESSIONS
|
|
2839
|
+
# })
|
|
2840
|
+
#
|
|
2841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/RevokeStreamUrl AWS API Documentation
|
|
2842
|
+
#
|
|
2843
|
+
# @overload revoke_stream_url(params = {})
|
|
2844
|
+
# @param [Hash] params ({})
|
|
2845
|
+
def revoke_stream_url(params = {}, options = {})
|
|
2846
|
+
req = build_request(:revoke_stream_url, params)
|
|
2847
|
+
req.send_request(options)
|
|
2848
|
+
end
|
|
2849
|
+
|
|
2342
2850
|
# This action initiates a new stream session and outputs connection
|
|
2343
2851
|
# information that clients can use to access the stream. A stream
|
|
2344
2852
|
# session refers to an instance of a stream that Amazon GameLift Streams
|
|
@@ -3093,7 +3601,7 @@ module Aws::GameLiftStreams
|
|
|
3093
3601
|
tracer: tracer
|
|
3094
3602
|
)
|
|
3095
3603
|
context[:gem_name] = 'aws-sdk-gameliftstreams'
|
|
3096
|
-
context[:gem_version] = '1.
|
|
3604
|
+
context[:gem_version] = '1.34.0'
|
|
3097
3605
|
Seahorse::Client::Request.new(handlers, context)
|
|
3098
3606
|
end
|
|
3099
3607
|
|