2026/07/29 - Amazon GameLift Streams - 5 new api methods
Changes 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.
Retrieves properties for a stream URL, including its current status, usage, and the stream sessions started through it.
If you delete the stream group or application that backs the stream URL, this operation updates the status of the stream URL to REVOKED.
See also: AWS API Documentation
Request Syntax
client.get_stream_url(
Identifier='string',
StreamUrlIdentifier='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
This is the stream group that owns the stream URL.
string
[REQUIRED]
The unique identifier of the stream URL. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4. Example ID: su-1AB2C3De4.
dict
Response Syntax
{
'Arn': 'string',
'StreamUrlId': 'string',
'StreamUrl': 'string',
'Status': 'ACTIVE'|'EXPIRED'|'REVOKED'|'LIMIT_REACHED',
'StatusReason': 'userRevoked'|'revokedAndTerminatingSessions'|'revokedAndSessionsTerminated'|'streamGroupDeleted'|'applicationDeleted',
'ExpiresAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'UsageLimit': 123,
'RemainingUses': 123,
'StreamGroupArn': 'string',
'ApplicationArn': 'string',
'Protocol': 'WebRTC',
'Locations': [
'string',
],
'SessionLengthSeconds': 123,
'Description': 'string',
'AdditionalLaunchArgs': [
'string',
],
'AdditionalEnvironmentVariables': {
'string': 'string'
},
'RoleArn': 'string',
'DisplayConfiguration': {
'Resolution': {
'Width': 123,
'Height': 123
}
},
'StreamSessions': [
{
'Arn': 'string',
'UserId': 'string',
'Status': 'ACTIVATING'|'ACTIVE'|'CONNECTED'|'PENDING_CLIENT_RECONNECTION'|'RECONNECTING'|'TERMINATING'|'TERMINATED'|'ERROR',
'StatusReason': 'internalError'|'invalidSignalRequest'|'placementTimeout'|'applicationLogS3DestinationError'|'assumeRoleFailed'|'applicationExit'|'connectionTimeout'|'reconnectionTimeout'|'maxSessionLengthTimeout'|'idleTimeout'|'apiTerminated',
'Protocol': 'WebRTC',
'LastUpdatedAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'ApplicationArn': 'string',
'ExportFilesMetadata': {
'Status': 'SUCCEEDED'|'FAILED'|'PENDING',
'StatusReason': 'string',
'OutputUri': 'string'
},
'Location': 'string',
'RoleArn': 'string'
},
]
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID].
StreamUrlId (string) --
The unique identifier for the stream URL resource, for example su-1AB2C3De4.
StreamUrl (string) --
The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.
Status (string) --
The current status of the stream URL. Possible statuses include the following:
ACTIVE: The stream URL is valid and can start stream sessions.
EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.
REVOKED: The stream URL was revoked and can no longer start stream sessions.
LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.
StatusReason (string) --
Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:
userRevoked: You revoked the stream URL.
revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.
revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.
streamGroupDeleted: The stream group was deleted, which revoked the stream URL.
applicationDeleted: The application was deleted, which revoked the stream URL.
ExpiresAt (datetime) --
The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
UsageLimit (integer) --
The maximum number of times the stream URL can start a stream session.
RemainingUses (integer) --
The number of times the stream URL can still be used to start a stream session.
StreamGroupArn (string) --
The stream group that runs the stream sessions.
This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
ApplicationArn (string) --
The application that runs in the stream sessions.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Protocol (string) --
The data transport protocol used for stream sessions started from this stream URL.
Locations (list) --
The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
(string) --
SessionLengthSeconds (integer) --
The maximum length of time, in seconds, that a stream session started from this stream URL can run.
Description (string) --
The descriptive label for the stream URL.
AdditionalLaunchArgs (list) --
The command-line arguments passed to the application when a stream session starts.
(string) --
AdditionalEnvironmentVariables (dict) --
The environment variables made available to the application when a stream session starts.
(string) --
(string) --
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.
DisplayConfiguration (dict) --
The display settings, such as resolution, for stream sessions started from this stream URL.
Resolution (dict) --
The resolution to apply to the stream session's virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.
Width (integer) --
The width of the stream session's virtual monitor, in pixels. The value must be an even number.
Height (integer) --
The height of the stream session's virtual monitor, in pixels. The value must be an even number.
StreamSessions (list) --
A list of the stream sessions that have been started through this stream URL.
(dict) --
Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
Arn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567.
UserId (string) --
An opaque, unique identifier for an end-user, defined by the developer.
Status (string) --
The current status of the stream session resource.
ACTIVATING: The stream session is starting and preparing to stream.
ACTIVE: The stream session is ready and waiting for a client connection. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches ACTIVE state to establish a connection. If no client connects within this timeframe, the session automatically terminates.
CONNECTED: The stream session has a connected client. A session will automatically terminate if there is no user input for 60 minutes, or if the maximum length of a session specified by SessionLengthSeconds in StartStreamSession is exceeded.
ERROR: The stream session failed to activate. See StatusReason (returned by GetStreamSession and StartStreamSession) for more information.
PENDING_CLIENT_RECONNECTION: A client has recently disconnected and the stream session is waiting for the client to reconnect. A client has ConnectionTimeoutSeconds (specified in StartStreamSession) from when the session reaches PENDING_CLIENT_RECONNECTION state to re-establish a connection. If no client connects within this timeframe, the session automatically terminates.
RECONNECTING: A client has initiated a reconnect to a session that was in PENDING_CLIENT_RECONNECTION state.
TERMINATING: The stream session is ending.
TERMINATED: The stream session has ended.
StatusReason (string) --
A short description of the reason the stream session is in ERROR status or TERMINATED status.
ERROR status reasons:
applicationLogS3DestinationError: Could not write the application log to the Amazon S3 bucket that is configured for the streaming application. Make sure the bucket still exists.
internalError: An internal service error occurred. Start a new stream session to continue streaming.
invalidSignalRequest: The WebRTC signal request that was sent is not valid. When starting or reconnecting to a stream session, use generateSignalRequest in the Amazon GameLift Streams Web SDK to generate a new signal request.
placementTimeout: Amazon GameLift Streams could not find available stream capacity to start a stream session. Increase the stream capacity in the stream group or wait until capacity becomes available.
TERMINATED status reasons:
apiTerminated: The stream session was terminated by an API call to TerminateStreamSession.
applicationExit: The streaming application exited or crashed. The stream session was terminated because the application is no longer running.
connectionTimeout: The stream session was terminated because the client failed to connect within the connection timeout period specified by ConnectionTimeoutSeconds.
maxSessionLengthTimeout: The stream session was terminated because it exceeded the maximum session length timeout period specified by SessionLengthSeconds.
reconnectionTimeout: The stream session was terminated because the client failed to reconnect within the reconnection timeout period specified by ConnectionTimeoutSeconds after losing connection.
Protocol (string) --
The data transfer protocol in use with the stream session.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
ApplicationArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
ExportFilesMetadata (dict) --
Provides details about the stream session's exported files.
Status (string) --
The result of the ExportStreamSessionFiles operation.
StatusReason (string) --
A short description of the reason the export is in FAILED status.
OutputUri (string) --
The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.
Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.
Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.
Location (string) --
The location where Amazon GameLift Streams hosts and streams your application. For example, us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
RoleArn (string) --
The ARN of the AWS Identity and Access Management (IAM) role that Amazon GameLift Streams assumes on behalf of your application during the stream session.
Retrieves a list of the stream URLs in the current Amazon Web Services Region for your Amazon Web Services account. You can filter the results by status or by stream group. Use the pagination parameters to retrieve results as a set of sequential pages. If you delete the stream group or application that backs a stream URL, this operation updates that stream URL's status to REVOKED.
See also: AWS API Documentation
Request Syntax
client.list_stream_urls(
Status='ACTIVE'|'EXPIRED'|'REVOKED'|'LIMIT_REACHED',
StreamGroupIdentifier='string',
NextToken='string',
MaxResults=123
)
string
Filters the list to stream URLs with the specified status.
ACTIVE: The stream URL is valid and can start stream sessions.
EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.
REVOKED: The stream URL was revoked and can no longer start stream sessions.
LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.
string
Filters the list to stream URLs that belong to the specified stream group.
This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
string
The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.
integer
The maximum number of results to return per page. Valid values are 1-100. The default is 25.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'StreamUrlId': 'string',
'StreamUrl': 'string',
'Status': 'ACTIVE'|'EXPIRED'|'REVOKED'|'LIMIT_REACHED',
'StatusReason': 'userRevoked'|'revokedAndTerminatingSessions'|'revokedAndSessionsTerminated'|'streamGroupDeleted'|'applicationDeleted',
'ExpiresAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'UsageLimit': 123,
'RemainingUses': 123,
'StreamGroupArn': 'string',
'ApplicationArn': 'string',
'SessionLengthSeconds': 123,
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration.
(dict) --
Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call GetStreamUrl.
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID].
StreamUrlId (string) --
The unique identifier for the stream URL resource, for example su-1AB2C3De4.
StreamUrl (string) --
The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.
Status (string) --
The current status of the stream URL. Possible statuses include the following:
ACTIVE: The stream URL is valid and can start stream sessions.
EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.
REVOKED: The stream URL was revoked and can no longer start stream sessions.
LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.
StatusReason (string) --
Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:
userRevoked: You revoked the stream URL.
revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.
revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.
streamGroupDeleted: The stream group was deleted, which revoked the stream URL.
applicationDeleted: The application was deleted, which revoked the stream URL.
ExpiresAt (datetime) --
The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
UsageLimit (integer) --
The maximum number of times the stream URL can start a stream session.
RemainingUses (integer) --
The number of times the stream URL can still be used to start a stream session.
StreamGroupArn (string) --
The stream group that runs the stream sessions.
This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
ApplicationArn (string) --
The application that runs in the stream sessions.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
SessionLengthSeconds (integer) --
The maximum length of time, in seconds, that a stream session started from this stream URL can run.
Description (string) --
The descriptive label for the stream URL.
NextToken (string) --
A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list.
Revokes a stream URL so that it can no longer start new stream sessions. By default, stream sessions that are already running continue until they end on their own. To also end running sessions, set RevocationMode to REVOKE_AND_TERMINATE_SESSIONS.
Revoking a stream URL is permanent. The status of the stream URL changes to REVOKED.
See also: AWS API Documentation
Request Syntax
client.revoke_stream_url(
Identifier='string',
StreamUrlIdentifier='string',
RevocationMode='REVOKE_URL'|'REVOKE_AND_TERMINATE_SESSIONS'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
This is the stream group that owns the stream URL.
string
[REQUIRED]
The unique identifier of the stream URL to revoke. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4. Example ID: su-1AB2C3De4.
string
Controls what happens to running stream sessions when you revoke the stream URL. If you do not specify a value, the default is REVOKE_URL. Possible values include the following:
REVOKE_URL: Stops the stream URL from starting new stream sessions. Running sessions continue until they end.
REVOKE_AND_TERMINATE_SESSIONS: Stops new stream sessions and ends any running stream sessions.
None
Creates a stream URL that grants temporary access to a stream session in a web browser without requiring an Amazon Web Services account or client integration.
You can use the stream URL to start a stream session up to the number of times set by UsageLimit, until it expires after UrlExpiresAfterMinutes. Each successful use starts a new stream session.
To make the request idempotent, provide a ClientToken.
See also: AWS API Documentation
Request Syntax
client.create_stream_url(
Identifier='string',
ApplicationIdentifier='string',
Protocol='WebRTC',
UrlExpiresAfterMinutes=123,
UsageLimit=123,
Description='string',
Locations=[
'string',
],
SessionLengthSeconds=123,
AdditionalLaunchArgs=[
'string',
],
AdditionalEnvironmentVariables={
'string': 'string'
},
RoleArn='string',
DisplayConfiguration={
'Resolution': {
'Width': 123,
'Height': 123
}
},
ClientToken='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.
The stream session runs in this stream group.
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
This application must be associated with the stream group.
string
[REQUIRED]
The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC.
integer
[REQUIRED]
The number of minutes after creation that the stream URL remains valid. After this period, the status of the stream URL changes to EXPIRED and it can no longer start stream sessions. The minimum is 1 minute. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
integer
The maximum number of times the stream URL can start a stream session. Each successful use reduces the remaining uses by one. The minimum is 1, and the default is 1. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
string
A descriptive label for the stream URL.
list
[REQUIRED]
A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, for example us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
(string) --
integer
The maximum length of time, in seconds, that a stream session started from this stream URL can run. Valid values are 1-86400 seconds (1 second to 24 hours). The default is 43200 seconds (12 hours).
list
A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
dict
A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
(string) --
(string) --
string
The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.
dict
The display settings, such as resolution, for stream sessions started from this stream URL.
Resolution (dict) --
The resolution to apply to the stream session's virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.
Width (integer) -- [REQUIRED]
The width of the stream session's virtual monitor, in pixels. The value must be an even number.
Height (integer) -- [REQUIRED]
The height of the stream session's virtual monitor, in pixels. The value must be an even number.
string
A unique, case-sensitive identifier that you provide to ensure this request is idempotent. If you retry a request with the same ClientToken, Amazon GameLift Streams returns the original response without performing the operation again.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Arn': 'string',
'StreamUrlId': 'string',
'StreamUrl': 'string',
'Status': 'ACTIVE'|'EXPIRED'|'REVOKED'|'LIMIT_REACHED',
'StatusReason': 'userRevoked'|'revokedAndTerminatingSessions'|'revokedAndSessionsTerminated'|'streamGroupDeleted'|'applicationDeleted',
'ExpiresAt': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'UsageLimit': 123,
'RemainingUses': 123,
'StreamGroupArn': 'string',
'ApplicationArn': 'string',
'Protocol': 'WebRTC',
'Locations': [
'string',
],
'SessionLengthSeconds': 123,
'Description': 'string',
'AdditionalLaunchArgs': [
'string',
],
'AdditionalEnvironmentVariables': {
'string': 'string'
},
'RoleArn': 'string',
'DisplayConfiguration': {
'Resolution': {
'Width': 123,
'Height': 123
}
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID].
StreamUrlId (string) --
The unique identifier for the stream URL resource, for example su-1AB2C3De4.
StreamUrl (string) --
The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.
Status (string) --
The current status of the stream URL. Possible statuses include the following:
ACTIVE: The stream URL is valid and can start stream sessions.
EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.
REVOKED: The stream URL was revoked and can no longer start stream sessions.
LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.
StatusReason (string) --
Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:
userRevoked: You revoked the stream URL.
revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.
revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.
streamGroupDeleted: The stream group was deleted, which revoked the stream URL.
applicationDeleted: The application was deleted, which revoked the stream URL.
ExpiresAt (datetime) --
The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
CreatedAt (datetime) --
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
UsageLimit (integer) --
The maximum number of times the stream URL can start a stream session.
RemainingUses (integer) --
The number of times the stream URL can still be used to start a stream session.
StreamGroupArn (string) --
The stream group that runs the stream sessions.
This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
ApplicationArn (string) --
The application that runs in the stream sessions.
This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Protocol (string) --
The data transport protocol used for stream sessions started from this stream URL.
Locations (list) --
The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
(string) --
SessionLengthSeconds (integer) --
The maximum length of time, in seconds, that a stream session started from this stream URL can run.
Description (string) --
The descriptive label for the stream URL.
AdditionalLaunchArgs (list) --
The command-line arguments passed to the application when a stream session starts.
(string) --
AdditionalEnvironmentVariables (dict) --
The environment variables made available to the application when a stream session starts.
(string) --
(string) --
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.
DisplayConfiguration (dict) --
The display settings, such as resolution, for stream sessions started from this stream URL.
Resolution (dict) --
The resolution to apply to the stream session's virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.
Width (integer) --
The width of the stream session's virtual monitor, in pixels. The value must be an even number.
Height (integer) --
The height of the stream session's virtual monitor, in pixels. The value must be an even number.
Lists the shader caches associated with an Amazon GameLift Streams application. Each shader cache entry includes its status, associated stream groups, and size in bytes.
Returns shader caches associated with the specified Amazon GameLift Streams application in all statuses.
See also: AWS API Documentation
Request Syntax
client.list_application_shader_caches(
Identifier='string'
)
string
[REQUIRED]
An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
dict
Response Syntax
{
'Items': [
{
'Identifier': 'string',
'ApplicationArn': 'string',
'Status': 'INITIALIZED'|'PROCESSING'|'READY'|'DELETING'|'ERROR',
'LastUpdatedAt': datetime(2015, 1, 1),
'StorageBytes': 123,
'AssociatedStreamGroups': [
'string',
]
},
]
}
Response Structure
(dict) --
Items (list) --
A collection of shader cache metadata for the specified Amazon GameLift Streams application. Each item includes the shader cache status, associated stream groups, and storage size.
(dict) --
Describes a shader cache associated with an Amazon GameLift Streams application.
Identifier (string) --
A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27.
ApplicationArn (string) --
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Status (string) --
The current status of the shader cache. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.
PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.
READY: The shader cache is replicated and available for use in stream sessions.
DELETING: Amazon GameLift Streams is deleting the shader cache.
ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.
LastUpdatedAt (datetime) --
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
StorageBytes (integer) --
The total storage used by all compiled shader files in this shader cache, in bytes.
AssociatedStreamGroups (list) --
The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
(string) --