Add locations that can host stream sessions. To add a location, the stream group must be in ACTIVE status. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality.
This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions.
" }, "AssociateApplications":{ "name":"AssociateApplications", "http":{ "method":"POST", "requestUri":"/streamgroups/{Identifier}/associations", "responseCode":200 }, "input":{"shape":"AssociateApplicationsInput"}, "output":{"shape":"AssociateApplicationsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.
If a stream group does not already have a linked application, Amazon GameLift Streams will automatically assign the first application provided in ApplicationIdentifiers as the default.
Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it.
Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide.
Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application.
Creating an application is the only time Amazon GameLift Streams accesses your Amazon S3 bucket. After the application reaches READY status, you can delete the original files from your Amazon S3 bucket without affecting the application.
If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to INITIALIZED. When an application reaches READY status, you can use the application to set up stream groups and start streams. To track application status, call GetApplication.
Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory.
Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. The following capacity settings are available:
Always-on capacity: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
Maximum capacity: This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
Target-idle capacity: This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.
To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.
If the CreateStreamGroup request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be ACTIVE and you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.
Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the ExpiresAt field.
Creates an administrative terminal session with full access to the live runtime environment of the Amazon GameLift Streams stream session. Use the returned credentials (SessionId, StreamUrl and TokenValue) with the Amazon Web Services Systems Manager Session Manager plugin for the CLI to access the terminal session.
The stream session must be in one of the following statuses: ACTIVE, CONNECTED, PENDING_CLIENT_RECONNECTION, or RECONNECTING.
The StreamUrl is valid for 60 seconds. After it expires, call this operation again to get a new URL.
The returned credentials grant full access to the live runtime environment of the Amazon GameLift Streams stream session. The operator who connects to the terminal session has the same level of access that your Amazon GameLift Streams applications have, including potentially user input, screen images, and application data files. Grant permissions to call this operation only to trusted IAM identities that require live runtime environment access.
Enables clients to reconnect to a stream session while preserving all session state and data in the disconnected session. This reconnection process can be initiated when a stream session is in either PENDING_CLIENT_RECONNECTION or ACTIVE status. The process works as follows:
Initial disconnect:
When a client disconnects or loses connection, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION
Reconnection time window:
Clients have ConnectionTimeoutSeconds (defined in StartStreamSession) to reconnect before session termination
Your backend server must call CreateStreamSessionConnection to initiate reconnection
Session transitions to RECONNECTING status
Reconnection completion:
On successful CreateStreamSessionConnection, session status changes to ACTIVE
Provide the new connection information to the requesting client
Client must establish connection within ConnectionTimeoutSeconds
Session terminates automatically if client fails to connect in time
For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.
To begin re-connecting to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, and the signal request to use with the stream.
" }, "CreateStreamUrl":{ "name":"CreateStreamUrl", "http":{ "method":"POST", "requestUri":"/streamgroups/{Identifier}/streamurls", "responseCode":201 }, "input":{"shape":"CreateStreamUrlInput"}, "output":{"shape":"CreateStreamUrlOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"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.
Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket.
You can only delete an application that meets the following conditions:
The application is in READY or ERROR status. You cannot delete an application that's in PROCESSING or INITIALIZED status.
The application is not the default application of any stream groups. You must first delete the stream group by using DeleteStreamGroup.
The application is not linked to any stream groups. You must first unlink the stream group by using DisassociateApplications.
An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call TerminateStreamSession to end the stream.
If any active stream groups exist for this application, this request returns a ValidationException.
Permanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream group identifier. During the deletion process, the stream group's status is DELETING. This operation stops streams in progress and prevents new streams from starting. As a best practice, before deleting the stream group, call ListStreamSessions to check for streams in progress and take action to stop them. When you delete a stream group, any application associations referring to that stream group are automatically removed.
When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. To disassociate an application, the stream group must be in ACTIVE status.
If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call UpdateStreamGroup and specify a new DefaultApplicationIdentifier.
Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output.
You can only call this action on a stream session that is in progress, specifically in one of the following statuses ACTIVE, CONNECTED, PENDING_CLIENT_RECONNECTION, and RECONNECTING. You must provide an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your security credentials to authenticate and authorize access to your Amazon S3 bucket.
Amazon GameLift Streams collects the following generated and modified files. Find them in the corresponding folders in the .zip archive.
application/: The folder where your application or game is stored.
profile/: The user profile folder.
temp/: The system temp folder.
To verify the status of the exported files, use GetStreamSession.
To delete the files, delete the object in the S3 bucket.
", "idempotent":true }, "GetApplication":{ "name":"GetApplication", "http":{ "method":"GET", "requestUri":"/applications/{Identifier}", "responseCode":200 }, "input":{"shape":"GetApplicationInput"}, "output":{"shape":"GetApplicationOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application.
", "readonly":true }, "GetStreamGroup":{ "name":"GetStreamGroup", "http":{ "method":"GET", "requestUri":"/streamgroups/{Identifier}", "responseCode":200 }, "input":{"shape":"GetStreamGroupInput"}, "output":{"shape":"GetStreamGroupOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.
", "readonly":true }, "GetStreamSession":{ "name":"GetStreamSession", "http":{ "method":"GET", "requestUri":"/streamgroups/{Identifier}/streamsessions/{StreamSessionIdentifier}", "responseCode":200 }, "input":{"shape":"GetStreamSessionInput"}, "output":{"shape":"GetStreamSessionOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource.
", "readonly":true }, "GetStreamUrl":{ "name":"GetStreamUrl", "http":{ "method":"GET", "requestUri":"/streamgroups/{Identifier}/streamurls/{StreamUrlIdentifier}", "responseCode":200 }, "input":{"shape":"GetStreamUrlInput"}, "output":{"shape":"GetStreamUrlOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"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.
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.
", "readonly":true }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"GET", "requestUri":"/applications", "responseCode":200 }, "input":{"shape":"ListApplicationsInput"}, "output":{"shape":"ListApplicationsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.
", "readonly":true }, "ListStreamGroups":{ "name":"ListStreamGroups", "http":{ "method":"GET", "requestUri":"/streamgroups", "responseCode":200 }, "input":{"shape":"ListStreamGroupsInput"}, "output":{"shape":"ListStreamGroupsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.
", "readonly":true }, "ListStreamSessions":{ "name":"ListStreamSessions", "http":{ "method":"GET", "requestUri":"/streamgroups/{Identifier}/streamsessions", "responseCode":200 }, "input":{"shape":"ListStreamSessionsInput"}, "output":{"shape":"ListStreamSessionsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.
To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed.
This operation returns the requested stream sessions in no particular order.
", "readonly":true }, "ListStreamSessionsByAccount":{ "name":"ListStreamSessionsByAccount", "http":{ "method":"GET", "requestUri":"/streamsessions", "responseCode":200 }, "input":{"shape":"ListStreamSessionsByAccountInput"}, "output":{"shape":"ListStreamSessionsByAccountOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.
In the returned list of stream sessions, the ExportFilesMetadata property only shows the Status value. To get the OutpurUri and StatusReason values, use GetStreamSession.
We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use GetStreamSession.
", "readonly":true }, "ListStreamUrls":{ "name":"ListStreamUrls", "http":{ "method":"GET", "requestUri":"/streamurls", "responseCode":200 }, "input":{"shape":"ListStreamUrlsInput"}, "output":{"shape":"ListStreamUrlsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"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.
Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
", "readonly":true }, "RemoveStreamGroupLocations":{ "name":"RemoveStreamGroupLocations", "http":{ "method":"DELETE", "requestUri":"/streamgroups/{Identifier}/locations", "responseCode":204 }, "input":{"shape":"RemoveStreamGroupLocationsInput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":" Removes a set of remote locations from this stream group. To remove a location, the stream group must be in ACTIVE status. When you remove a location, Amazon GameLift Streams releases allocated compute resources in that location. Stream sessions can no longer start from removed locations in a stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal Amazon S3 bucket at this location.
You cannot remove the Amazon Web Services Region location where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero to avoid incurring costs for allocated compute resources in that location.
", "idempotent":true }, "RevokeStreamUrl":{ "name":"RevokeStreamUrl", "http":{ "method":"POST", "requestUri":"/streamgroups/{Identifier}/streamurls/{StreamUrlIdentifier}/revoke", "responseCode":204 }, "input":{"shape":"RevokeStreamUrlInput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"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.
This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows:
Prerequisites:
You must have a stream group in ACTIVE status
You must have idle or on-demand capacity in a stream group in the location you want to stream from
You must have at least one application associated to the stream group (use AssociateApplications if needed)
Start stream request:
Your backend server calls StartStreamSession to initiate connection
Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream
Session transitions to ACTIVATING status
Placement completion:
If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to ACTIVE status and StartStreamSession returns stream connection information
If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to ERROR status and StartStreamSession returns a StatusReason of placementTimeout
Connection completion:
Provide the new connection information to the requesting client
Client must establish connection within ConnectionTimeoutSeconds (specified in StartStreamSession parameters)
Session terminates automatically if client fails to connect in time
For more information about the stream session lifecycle, see Stream sessions in the Amazon GameLift Streams Developer Guide.
Timeouts to be aware of that affect a stream session:
Placement timeout: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:
Always-on capacity: 75 seconds
On-demand capacity:
Linux/Proton runtimes: 90 seconds
Windows runtime: 10 minutes
Connection timeout: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in ACTIVE status, or reconnect to a stream session in PENDING_CLIENT_RECONNECTION status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by ConnectionTimeoutSeconds in the StartStreamSession parameters.
Maximum session length: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by SessionLengthSeconds in the StartStreamSession parameters.
To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.
For stream groups that have multiple locations, provide a set of locations ordered by priority using a Locations parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.
To reconnect to a stream session after a client disconnects or loses connection, use CreateStreamSessionConnection.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Assigns one or more tags to a Amazon GameLift Streams resource. Use tags to organize Amazon Web Services resources for a range of purposes. You can assign tags to the following Amazon GameLift Streams resource types:
Application
StreamGroup
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
", "idempotent":true }, "TerminateStreamSession":{ "name":"TerminateStreamSession", "http":{ "method":"DELETE", "requestUri":"/streamgroups/{Identifier}/streamsessions/{StreamSessionIdentifier}", "responseCode":204 }, "input":{"shape":"TerminateStreamSessionInput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"Permanently terminates an active stream session. When called, the stream session status changes to TERMINATING. You can terminate a stream session in any status except ACTIVATING. If the stream session is in ACTIVATING status, an exception is thrown.
Removes one or more tags from a Amazon GameLift Streams resource. To remove tags, specify the Amazon GameLift Streams resource and a list of one or more tags to remove.
", "idempotent":true }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"PATCH", "requestUri":"/applications/{Identifier}", "responseCode":200 }, "input":{"shape":"UpdateApplicationInput"}, "output":{"shape":"UpdateApplicationOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":" Updates the mutable configuration settings for a Amazon GameLift Streams application resource. You can change the Description, ApplicationLogOutputUri, and ApplicationLogPaths.
To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application.
" }, "UpdateStreamGroup":{ "name":"UpdateStreamGroup", "http":{ "method":"PATCH", "requestUri":"/streamgroups/{Identifier}", "responseCode":200 }, "input":{"shape":"UpdateStreamGroupInput"}, "output":{"shape":"UpdateStreamGroupOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":" Updates the configuration settings for an Amazon GameLift Streams stream group resource. To update a stream group, it must be in ACTIVE status. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group.
Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. The following capacity settings are available:
Always-on capacity: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
Maximum capacity: This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
Target-idle capacity: This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.
To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group. Expired stream groups cannot be updated.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Description of the error.
" } }, "documentation":"You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AddStreamGroupLocationsInput":{ "type":"structure", "required":[ "Identifier", "LocationConfigurations" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"A stream group to add the specified locations to.
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.
A set of one or more locations and the streaming capacity for each location.
" } } }, "AddStreamGroupLocationsOutput":{ "type":"structure", "required":[ "Identifier", "Locations" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
A human-readable label for the application. You can edit this value.
" }, "Status":{ "shape":"ApplicationStatus", "documentation":"The current status of the application resource. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.
PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.
READY: The application is ready to deploy in a stream group.
ERROR: An error occurred when setting up the application. For more information about the error, call GetApplication and refer to StatusReason.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
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).
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).
Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)
For Windows applications
Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)
Proton 10.0-4 (Type=PROTON, Version=20260204)
Proton 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication.
" }, "ApplicationSummaryList":{ "type":"list", "member":{"shape":"ApplicationSummary"} }, "Arn":{ "type":"string", "max":128, "min":1, "pattern":"arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)" }, "ArnList":{ "type":"list", "member":{"shape":"Arn"} }, "AssociateApplicationsInput":{ "type":"structure", "required":[ "Identifier", "ApplicationIdentifiers" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"A stream group to associate to the applications.
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.
A set of applications to associate with the stream group.
This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
A stream group that is associated to the applications.
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.
A set of applications that are associated to the stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Description of the error.
" } }, "documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ConnectionTimeoutSeconds":{ "type":"integer", "box":true, "max":3600, "min":1 }, "CreateApplicationInput":{ "type":"structure", "required":[ "Description", "RuntimeEnvironment", "ExecutablePath", "ApplicationSourceUri" ], "members":{ "Description":{ "shape":"Description", "documentation":"A human-readable label for the application. You can update this value later.
" }, "RuntimeEnvironment":{ "shape":"RuntimeEnvironment", "documentation":"Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)
For Windows applications
Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)
Proton 10.0-4 (Type=PROTON, Version=20260204)
Proton 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
The relative path and file name of the executable file that Amazon GameLift Streams will stream. Specify a path relative to the location set in ApplicationSourceUri. The file must be contained within the application's root folder. For Windows applications, the file must be a valid Windows executable or batch file with a filename ending in .exe, .cmd, or .bat. For Linux applications, the file must be a valid Linux binary executable or a script that contains an initial interpreter line starting with a shebang ('#!').
The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location.
This value is immutable. To designate a different content location, create a new application.
The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.
Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location, or relative to the user's home directory when using a supported path variable. You can specify up to 10 log paths. Each individual log file cannot exceed 50 MB in size.
Each path can be a directory or an exact file path. When you specify a directory, Amazon GameLift Streams collects only files with the following extensions: .txt, .log, and .utrace. To collect files with other extensions, specify the exact file path. The copy operation is not performed recursively in subfolders.
The following path variables are recognized when they appear as the first component of a path: %USERPROFILE% (Windows and Proton), $HOME or ~ (Linux). Use a path variable when your application writes logs outside of the application directory.
Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.
The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.
A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
" }, "ClientToken":{ "shape":"ClientToken", "documentation":"A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
", "idempotencyToken":true } } }, "CreateApplicationOutput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"Identifier", "documentation":"The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].
A human-readable label for the application. You can edit this value.
" }, "RuntimeEnvironment":{ "shape":"RuntimeEnvironment", "documentation":"Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)
For Windows applications
Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)
Proton 10.0-4 (Type=PROTON, Version=20260204)
Proton 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
The relative path and file name of the executable file that launches the content for streaming.
" }, "ApplicationLogPaths":{ "shape":"FilePaths", "documentation":"Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.
The original Amazon S3 location of uploaded stream content for the application.
" }, "Id":{ "shape":"Id", "documentation":"A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.
The current status of the application resource. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.
PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.
READY: The application is ready to deploy in a stream group.
ERROR: An error occurred when setting up the application. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
A short description of the status reason when the application is in ERROR status.
A set of replication statuses for each location.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"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).
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).
A newly created application is not associated to any stream groups. This value is empty.
" } } }, "CreateStreamGroupInput":{ "type":"structure", "required":[ "Description", "StreamClass" ], "members":{ "Description":{ "shape":"Description", "documentation":"A descriptive label for the stream group.
" }, "StreamClass":{ "shape":"StreamClass", "documentation":"The target stream quality for sessions that are hosted in this stream group. Set a stream class that is appropriate to the type of content that you're streaming. Stream class determines the type of computing resources Amazon GameLift Streams uses and impacts the cost of streaming. The following options are available:
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.
If you do not link an application when you create a stream group, you will need to link one later, before you can start streaming, using AssociateApplications.
This value is 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.
A set of one or more locations and the streaming capacity for each location.
" }, "Tags":{ "shape":"Tags", "documentation":"A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
" }, "ClientToken":{ "shape":"ClientToken", "documentation":"A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
", "idempotencyToken":true } } }, "CreateStreamGroupOutput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"Identifier", "documentation":"The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
A descriptive label for the stream group.
" }, "DefaultApplication":{ "shape":"DefaultApplication", "documentation":"The default Amazon GameLift Streams application that is associated with this stream group.
" }, "LocationStates":{ "shape":"LocationStates", "documentation":"This value is the set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:
internalError: The request can't process right now because of an issue with the server. Try again later.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
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).
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).
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
The stream group that runs this stream session.
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.
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.
An Amazon Web Services Systems Manager session identifier that uniquely identifies the requested terminal session. Use this value with the Amazon Web Services Systems Manager Session Manager plugin.
" }, "StreamUrl":{ "shape":"StreamUrl", "documentation":"An Amazon Web Services Systems Manager WebSocket connection endpoint for the requested terminal session.
" }, "TokenValue":{ "shape":"TokenValue", "documentation":"An Amazon Web Services Systems Manager authentication token that authenticates your access to the session ID and WebSocket URL. This token must be treated with the same level of security as other user credentials. The token value is only valid for establishing a new connection within 60 seconds of generation.
" } } }, "CreateStreamSessionConnectionInput":{ "type":"structure", "required":[ "Identifier", "StreamSessionIdentifier", "SignalRequest" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
", "idempotencyToken":true }, "Identifier":{ "shape":"Identifier", "documentation":" 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 group that you want to run this stream session with. The stream group must be in ACTIVE status.
Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.
The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.
A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to StartStreamSession.
The WebRTC answer string that the stream server generates in response to the SignalRequest.
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.
", "location":"uri", "locationName":"Identifier" }, "ApplicationIdentifier":{ "shape":"Identifier", "documentation":"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.
" }, "Protocol":{ "shape":"Protocol", "documentation":"The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC.
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.
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.
" }, "Description":{ "shape":"Description", "documentation":"A descriptive label for the stream URL.
" }, "Locations":{ "shape":"LocationList", "documentation":"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.
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).
" }, "AdditionalLaunchArgs":{ "shape":"GameLaunchArgList", "documentation":"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.
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.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
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":{ "shape":"DisplayConfiguration", "documentation":"The display settings, such as resolution, for stream sessions started from this stream URL.
" }, "ClientToken":{ "shape":"ClientToken", "documentation":"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.
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].
The unique identifier for the stream URL resource, for example su-1AB2C3De4.
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":{ "shape":"StreamUrlStatus", "documentation":"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.
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.
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).
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).
The maximum number of times the stream URL can start a stream session.
" }, "RemainingUses":{ "shape":"RemainingUses", "documentation":"The number of times the stream URL can still be used to start a stream session.
" }, "StreamGroupArn":{ "shape":"Arn", "documentation":"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.
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.
The data transport protocol used for stream sessions started from this stream URL.
" }, "Locations":{ "shape":"LocationList", "documentation":"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.
" }, "SessionLengthSeconds":{ "shape":"SessionLengthSeconds", "documentation":"The maximum length of time, in seconds, that a stream session started from this stream URL can run.
" }, "Description":{ "shape":"Description", "documentation":"The descriptive label for the stream URL.
" }, "AdditionalLaunchArgs":{ "shape":"GameLaunchArgList", "documentation":"The command-line arguments passed to the application when a stream session starts.
" }, "AdditionalEnvironmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables made available to the application when a stream session starts.
" }, "RoleArn":{ "shape":"IamRoleArn", "documentation":"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":{ "shape":"DisplayConfiguration", "documentation":"The display settings, such as resolution, for stream sessions started from this stream URL.
" } } }, "DefaultApplication":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Represents the default Amazon GameLift Streams application that a stream group hosts.
" }, "DeleteApplicationInput":{ "type":"structure", "required":["Identifier"], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
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.
A stream group to disassociate these applications from.
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.
A set of applications that you want to disassociate from the stream group.
This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.
An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
A set of applications that are disassociated from this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
The resolution to apply to the stream session's virtual monitor. When specified, this value overrides the default resolution of 1920 × 1080.
" } }, "documentation":"The virtual monitor settings for a stream session, including the resolution. If not specified, the stream session uses the default resolution of 1920 × 1080.
" }, "EnvironmentVariables":{ "type":"map", "key":{"shape":"EnvironmentVariablesKeyString"}, "value":{"shape":"EnvironmentVariablesValueString"}, "max":50, "min":0 }, "EnvironmentVariablesKeyString":{ "type":"string", "max":256, "min":1, "pattern":"[_a-zA-Z][_a-zA-Z0-9]*" }, "EnvironmentVariablesValueString":{ "type":"string", "max":4096, "min":0 }, "ExecutablePath":{ "type":"string", "max":1024, "min":1 }, "ExportFilesMetadata":{ "type":"structure", "members":{ "Status":{ "shape":"ExportFilesStatus", "documentation":"The result of the ExportStreamSessionFiles operation.
" }, "StatusReason":{ "shape":"ExportFilesReason", "documentation":"A short description of the reason the export is in FAILED status.
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.
Provides details about the stream session's exported files.
" }, "ExportFilesReason":{ "type":"string", "max":1024, "min":0 }, "ExportFilesStatus":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED", "PENDING" ] }, "ExportStreamSessionFilesInput":{ "type":"structure", "required":[ "Identifier", "StreamSessionIdentifier", "OutputUri" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.
The S3 bucket URI where Amazon GameLift Streams uploads the set of compressed exported files for this 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.
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.
The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].
A human-readable label for the application. You can edit this value.
" }, "RuntimeEnvironment":{ "shape":"RuntimeEnvironment", "documentation":"Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)
For Windows applications
Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)
Proton 10.0-4 (Type=PROTON, Version=20260204)
Proton 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
The relative path and file name of the executable file that launches the content for streaming.
" }, "ApplicationLogPaths":{ "shape":"FilePaths", "documentation":"Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.
The original Amazon S3 location of uploaded stream content for the application.
" }, "Id":{ "shape":"Id", "documentation":"A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.
The current status of the application resource. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.
PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.
READY: The application is ready to deploy in a stream group.
ERROR: An error occurred when setting up the application. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
A short description of the status reason when the application is in ERROR status.
A set of replication statuses for each location.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"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).
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).
A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.
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.
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 Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
A descriptive label for the stream group.
" }, "DefaultApplication":{ "shape":"DefaultApplication", "documentation":"The default Amazon GameLift Streams application that is associated with this stream group.
" }, "LocationStates":{ "shape":"LocationStates", "documentation":"This value is the set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:
internalError: The request can't process right now because of an issue with the server. Try again later.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
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).
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).
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
The stream group that runs this stream session.
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.
An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.
The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID].
A human-readable label for the stream session. You can update this value at any time.
" }, "StreamGroupId":{ "shape":"Id", "documentation":"The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
An opaque, unique identifier for an end-user, defined by the developer.
" }, "Status":{ "shape":"StreamSessionStatus", "documentation":"The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.
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.
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.
The data transfer protocol in use with the stream session.
" }, "Location":{ "shape":"LocationName", "documentation":"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.
The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
" }, "SignalResponse":{ "shape":"SignalResponse", "documentation":"The WebRTC answer string that the stream server generates in response to the SignalRequest.
The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.
" }, "AdditionalLaunchArgs":{ "shape":"GameLaunchArgList", "documentation":"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.
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.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
The performance stats configuration for the stream session
" }, "LogFileLocationUri":{ "shape":"FileLocationUri", "documentation":"Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
" }, "WebSdkProtocolUrl":{ "shape":"WebSdkProtocolUrl", "documentation":"The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
" }, "LastUpdatedAt":{ "shape":"Timestamp", "documentation":"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).
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).
The application streaming in this session.
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.
Provides details about the stream session's exported files.
" }, "RoleArn":{ "shape":"IamRoleArn", "documentation":"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.
" }, "DisplayConfiguration":{ "shape":"DisplayConfiguration", "documentation":"The configuration for the stream session's virtual monitor.
" } } }, "GetStreamUrlInput":{ "type":"structure", "required":[ "Identifier", "StreamUrlIdentifier" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
", "location":"uri", "locationName":"Identifier" }, "StreamUrlIdentifier":{ "shape":"Identifier", "documentation":"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.
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].
The unique identifier for the stream URL resource, for example su-1AB2C3De4.
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":{ "shape":"StreamUrlStatus", "documentation":"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.
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.
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).
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).
The maximum number of times the stream URL can start a stream session.
" }, "RemainingUses":{ "shape":"RemainingUses", "documentation":"The number of times the stream URL can still be used to start a stream session.
" }, "StreamGroupArn":{ "shape":"Arn", "documentation":"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.
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.
The data transport protocol used for stream sessions started from this stream URL.
" }, "Locations":{ "shape":"LocationList", "documentation":"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.
" }, "SessionLengthSeconds":{ "shape":"SessionLengthSeconds", "documentation":"The maximum length of time, in seconds, that a stream session started from this stream URL can run.
" }, "Description":{ "shape":"Description", "documentation":"The descriptive label for the stream URL.
" }, "AdditionalLaunchArgs":{ "shape":"GameLaunchArgList", "documentation":"The command-line arguments passed to the application when a stream session starts.
" }, "AdditionalEnvironmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables made available to the application when a stream session starts.
" }, "RoleArn":{ "shape":"IamRoleArn", "documentation":"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":{ "shape":"DisplayConfiguration", "documentation":"The display settings, such as resolution, for stream sessions started from this stream URL.
" }, "StreamSessions":{ "shape":"StreamSessionSummaryList", "documentation":"A list of the stream sessions that have been started through this stream URL.
" } } }, "IamRoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[a-zA-Z-]*:iam::\\d{12}:role/.+", "sensitive":true }, "Id":{ "type":"string", "max":32, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "Identifier":{ "type":"string", "max":128, "min":1, "pattern":"(^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)" }, "Identifiers":{ "type":"list", "member":{"shape":"Identifier"}, "max":50, "min":1 }, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Description of the error.
" } }, "documentation":"The service encountered an internal error and is unable to complete the request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "Ipv4CidrBlock":{ "type":"string", "pattern":"(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[1-2][0-9]|3[0-2])" }, "Ipv4CidrBlockList":{ "type":"list", "member":{"shape":"Ipv4CidrBlock"}, "max":5, "min":1 }, "ListApplicationShaderCachesInput":{ "type":"structure", "required":["Identifier"], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
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.
" } } }, "ListApplicationsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
A collection of Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. Each item includes application metadata and status.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListStreamGroupsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"A 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.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and status, but doesn't include capacity information.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListStreamSessionsByAccountInput":{ "type":"structure", "members":{ "Status":{ "shape":"StreamSessionStatus", "documentation":"Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.
", "location":"querystring", "locationName":"Status" }, "ExportFilesStatus":{ "shape":"ExportFilesStatus", "documentation":"Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.
", "location":"querystring", "locationName":"ExportFilesStatus" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListStreamSessionsInput":{ "type":"structure", "required":["Identifier"], "members":{ "Status":{ "shape":"StreamSessionStatus", "documentation":"Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.
", "location":"querystring", "locationName":"Status" }, "ExportFilesStatus":{ "shape":"ExportFilesStatus", "documentation":"Filter by the exported files status. You can specify one status in each request to retrieve only sessions that currently have that exported files status.
Exported files can be in one of the following states:
SUCCEEDED: The exported files are successfully stored in an S3 bucket.
FAILED: The session ended but Amazon GameLift Streams couldn't collect and upload the files to S3.
PENDING: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.
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.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for. You can use either the stream group ID or the Amazon Resource Name (ARN).
", "location":"uri", "locationName":"Identifier" } } }, "ListStreamSessionsOutput":{ "type":"structure", "members":{ "Items":{ "shape":"StreamSessionSummaryList", "documentation":"A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and returned in response to a list request. Each item includes stream session metadata and status.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListStreamUrlsInput":{ "type":"structure", "members":{ "Status":{ "shape":"StreamUrlStatus", "documentation":"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.
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.
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.
", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return per page. Valid values are 1-100. The default is 25.
", "location":"querystring", "locationName":"MaxResults" } } }, "ListStreamUrlsOutput":{ "type":"structure", "members":{ "Items":{ "shape":"StreamUrlSummaryList", "documentation":"A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) that you want to retrieve tags for. To get an Amazon GameLift Streams resource ARN, call a List or Get operation for the resource.
", "location":"uri", "locationName":"ResourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"Tags", "documentation":"A collection of tags that have been assigned to the specified resource.
" } } }, "LocationConfiguration":{ "type":"structure", "required":["LocationName"], "members":{ "LocationName":{ "shape":"LocationName", "documentation":" A location's name. 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.
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
" }, "OnDemandCapacity":{ "shape":"OnDemandCapacity", "documentation":"This field is deprecated. Use MaximumCapacity instead. This parameter cannot be used with MaximumCapacity or TargetIdleCapacity in the same location configuration.
The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.
", "deprecated":true, "deprecatedMessage":"This input field is deprecated in favor of explicit MaximumCapacity values.", "deprecatedSince":"2025-12-17" }, "TargetIdleCapacity":{ "shape":"TargetIdleCapacity", "documentation":"This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
" }, "MaximumCapacity":{ "shape":"MaximumCapacity", "documentation":"This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
" }, "VpcTransitConfiguration":{ "shape":"VpcTransitConfiguration", "documentation":"Configuration for connecting the stream group to resources in your Amazon VPC using AWS Transit Gateway. This setting is optional. If specified, Amazon GameLift Streams creates a Transit Gateway to enable private network connectivity between the service VPC and your VPC. The VPC ID cannot be changed after the stream group is created, but you can update the CIDR blocks by calling UpdateStreamGroup.
" } }, "documentation":"Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types. To update the capacity for an existing stream group, call UpdateStreamGroup. To add a new location and specify its capacity, call AddStreamGroupLocations.
" }, "LocationConfigurations":{ "type":"list", "member":{"shape":"LocationConfiguration"}, "max":100, "min":1 }, "LocationList":{ "type":"list", "member":{"shape":"LocationName"}, "min":1 }, "LocationName":{ "type":"string", "max":20, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "LocationState":{ "type":"structure", "members":{ "LocationName":{ "shape":"LocationName", "documentation":" A location's name. 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.
This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
" }, "OnDemandCapacity":{ "shape":"OnDemandCapacity", "documentation":"The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location.
" }, "TargetIdleCapacity":{ "shape":"TargetIdleCapacity", "documentation":"This indicates idle capacity which the service pre-allocates and holds for you in anticipation of future activity. This helps to insulate your users from capacity-allocation delays. You pay for capacity which is held in this intentional idle state.
" }, "MaximumCapacity":{ "shape":"MaximumCapacity", "documentation":"This indicates the maximum capacity that the service can allocate for you. Newly created streams may take a few minutes to start. Capacity is released back to the service when idle. You pay for capacity that is allocated to you until it is released.
" }, "RequestedCapacity":{ "shape":"CapacityValue", "documentation":"This value is the always-on capacity that you most recently requested for a stream group. You request capacity separately for each location in a stream group. In response to an increase in requested capacity, Amazon GameLift Streams attempts to provision compute resources to make the stream group's allocated capacity meet requested capacity. When always-on capacity is decreased, it can take a few minutes to deprovision allocated capacity to match the requested capacity.
" }, "AllocatedCapacity":{ "shape":"CapacityValue", "documentation":"This value is the stream capacity that Amazon GameLift Streams has provisioned in a stream group that can respond immediately to stream requests. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests. When target-idle capacity is configured, the idle resources include the capacity buffer maintained beyond ongoing sessions. You pay for this capacity whether it's in use or not. After making changes to capacity, it can take a few minutes for the allocated capacity count to reflect the change while compute resources are allocated or deallocated. Similarly, when allocated on-demand capacity is no longer needed, it can take a few minutes for Amazon GameLift Streams to spin down the allocated capacity.
" }, "IdleCapacity":{ "shape":"CapacityValue", "documentation":"This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's ability to respond immediately to new stream requests with near-instant startup time.
" }, "InternalVpcIpv4CidrBlock":{ "shape":"Ipv4CidrBlock", "documentation":"The CIDR block of the service VPC for this location. Add this CIDR block to your VPC route table to enable traffic routing through the Transit Gateway.
" }, "VpcTransitConfiguration":{ "shape":"VpcTransitConfigurationResponse", "documentation":"The VPC transit configuration for this location, including the Transit Gateway details needed to complete the VPC attachment setup.
" } }, "documentation":"Represents a location and its corresponding stream capacity and status.
" }, "LocationStates":{ "type":"list", "member":{"shape":"LocationState"} }, "LocationsList":{ "type":"list", "member":{"shape":"String"}, "max":100, "min":1 }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaximumCapacity":{ "type":"integer", "box":true, "min":0 }, "NextToken":{"type":"string"}, "OnDemandCapacity":{ "type":"integer", "box":true, "min":0 }, "OutputUri":{ "type":"string", "max":1024, "min":0, "pattern":"s3://.*(/|\\.zip|\\.ZIP)" }, "PerformanceStatsConfiguration":{ "type":"structure", "members":{ "SharedWithClient":{ "shape":"Boolean", "documentation":"Performance stats for the session are streamed to the client when set to true. Defaults to false.
Configuration settings for sharing the stream session's performance stats with the client
" }, "Protocol":{ "type":"string", "enum":["WebRTC"] }, "RemainingUses":{ "type":"integer", "box":true, "min":0 }, "RemoveStreamGroupLocationsInput":{ "type":"structure", "required":[ "Identifier", "Locations" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"A stream group to remove the specified locations from.
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.
A set of locations to remove this stream group. 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.
", "location":"querystring", "locationName":"locations" } } }, "ReplicationStatus":{ "type":"structure", "members":{ "Location":{ "shape":"LocationName", "documentation":" A location's name. 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.
The current status of the replication process.
" } }, "documentation":"Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has finished replicating there.
" }, "ReplicationStatusType":{ "type":"string", "enum":[ "REPLICATING", "COMPLETED" ] }, "ReplicationStatuses":{ "type":"list", "member":{"shape":"ReplicationStatus"} }, "Resolution":{ "type":"structure", "required":[ "Width", "Height" ], "members":{ "Width":{ "shape":"ResolutionWidth", "documentation":"The width of the stream session's virtual monitor, in pixels. The value must be an even number.
" }, "Height":{ "shape":"ResolutionHeight", "documentation":"The height of the stream session's virtual monitor, in pixels. The value must be an even number.
" } }, "documentation":"Contains the width and height dimensions, in pixels, that define the resolution of the stream session's virtual monitor. The total number of pixels (width × height) must not exceed 2,073,600 (equivalent to 1920 × 1080).
" }, "ResolutionHeight":{ "type":"integer", "box":true, "max":4096, "min":320 }, "ResolutionWidth":{ "type":"integer", "box":true, "max":4096, "min":320 }, "ResourceNotFoundException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Description of the error.
" } }, "documentation":"The resource specified in the request was not found. Correct the request before you try again.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RevocationMode":{ "type":"string", "enum":[ "REVOKE_URL", "REVOKE_AND_TERMINATE_SESSIONS" ] }, "RevokeStreamUrlInput":{ "type":"structure", "required":[ "Identifier", "StreamUrlIdentifier" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
", "location":"uri", "locationName":"Identifier" }, "StreamUrlIdentifier":{ "shape":"Identifier", "documentation":"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.
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.
The operating system and other drivers. For Proton, this also includes the Proton compatibility layer.
" }, "Version":{ "shape":"RuntimeEnvironmentVersion", "documentation":"Versioned container environment for the application operating system.
" } }, "documentation":"Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)
For Windows applications
Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)
Proton 10.0-4 (Type=PROTON, Version=20260204)
Proton 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
Description of the error.
" } }, "documentation":"The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SessionId":{ "type":"string", "max":256, "min":1 }, "SessionLengthSeconds":{ "type":"integer", "box":true, "max":86400, "min":1 }, "ShaderCacheStatus":{ "type":"string", "enum":[ "INITIALIZED", "PROCESSING", "READY", "DELETING", "ERROR" ] }, "ShaderCacheSummary":{ "type":"structure", "required":[ "Identifier", "ApplicationArn" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27.
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
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.
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).
The total storage used by all compiled shader files in this shader cache, in bytes.
" }, "AssociatedStreamGroups":{ "shape":"ArnList", "documentation":"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.
Describes a shader cache associated with an Amazon GameLift Streams application.
" }, "ShaderCacheSummaryList":{ "type":"list", "member":{"shape":"ShaderCacheSummary"}, "max":1000, "min":0 }, "SignalRequest":{ "type":"string", "min":1, "sensitive":true }, "SignalResponse":{ "type":"string", "sensitive":true }, "StartStreamSessionInput":{ "type":"structure", "required":[ "Identifier", "Protocol", "SignalRequest", "ApplicationIdentifier" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
", "idempotencyToken":true }, "Description":{ "shape":"Description", "documentation":"A human-readable label for the stream session. You can update this value later.
" }, "Identifier":{ "shape":"Identifier", "documentation":"The stream group to run this stream session with.
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.
The data transport protocol to use for the stream session.
" }, "SignalRequest":{ "shape":"SignalRequest", "documentation":"A WebRTC ICE offer string to use when initializing a WebRTC connection. Typically, the offer is a very long JSON string. Provide the string as a text value in quotes.
Amazon GameLift Streams also supports setting the field to \"NO_CLIENT_CONNECTION\". This will create a session without needing any browser request or Web SDK integration. The session starts up as usual and waits for a reconnection from a browser, which is accomplished using CreateStreamSessionConnection.
" }, "ApplicationIdentifier":{ "shape":"Identifier", "documentation":"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.
An opaque, unique identifier for an end-user, defined by the developer.
" }, "Locations":{ "shape":"LocationList", "documentation":" A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream from. For example, us-east-1. Amazon GameLift Streams selects the location with the next available capacity to start a single stream session in. If this value is empty, Amazon GameLift Streams attempts to start a stream session in the primary location.
For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
" }, "ConnectionTimeoutSeconds":{ "shape":"ConnectionTimeoutSeconds", "documentation":"Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. Applies to both connection and reconnection scenarios. This time span starts when the stream session reaches ACTIVE state. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. Default value is 120.
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections. Default value is 43200 (12 hours).
" }, "AdditionalLaunchArgs":{ "shape":"GameLaunchArgList", "documentation":"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.
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.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
Configuration settings for sharing the stream session's performance stats with the client
" }, "RoleArn":{ "shape":"IamRoleArn", "documentation":"The ARN of an AWS Identity and Access Management (IAM) role that Amazon GameLift Streams assumes on your behalf during the stream session. The role grants Amazon GameLift Streams permission to obtain temporary credentials for your application. The role's trust policy must allow the gameliftstreams.amazonaws.com service principal to assume it. The role name must start with GameLiftStreams-.
The configuration for the stream session's virtual monitor, including the resolution settings.
If not specified, Amazon GameLift Streams uses the default resolution of 1920 × 1080.
" } } }, "StartStreamSessionOutput":{ "type":"structure", "members":{ "Arn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID].
A human-readable label for the stream session. You can update this value at any time.
" }, "StreamGroupId":{ "shape":"Id", "documentation":"The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
An opaque, unique identifier for an end-user, defined by the developer.
" }, "Status":{ "shape":"StreamSessionStatus", "documentation":"The current status of the stream session. A stream session is ready for a client to connect when in ACTIVE status.
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.
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.
The data transfer protocol in use with the stream session.
" }, "Location":{ "shape":"LocationName", "documentation":"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.
The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
" }, "SignalResponse":{ "shape":"SignalResponse", "documentation":"The WebRTC answer string that the stream server generates in response to the SignalRequest.
The length of time that Amazon GameLift Streams should wait for a client to connect or reconnect to the stream session. This time span starts when the stream session reaches ACTIVE or PENDING_CLIENT_RECONNECTION state. If no client connects (or reconnects) before the timeout, Amazon GameLift Streams terminates the stream session.
The maximum duration of a session. Amazon GameLift Streams will automatically terminate a session after this amount of time has elapsed, regardless of any existing client connections.
" }, "AdditionalLaunchArgs":{ "shape":"GameLaunchArgList", "documentation":"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.
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.
If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.
AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.
The performance stats configuration for the stream session
" }, "LogFileLocationUri":{ "shape":"FileLocationUri", "documentation":"Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.
" }, "WebSdkProtocolUrl":{ "shape":"WebSdkProtocolUrl", "documentation":"The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
" }, "LastUpdatedAt":{ "shape":"Timestamp", "documentation":"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).
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).
The application streaming in this session.
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.
Provides details about the stream session's exported files.
" }, "RoleArn":{ "shape":"IamRoleArn", "documentation":"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.
" }, "DisplayConfiguration":{ "shape":"DisplayConfiguration", "documentation":"The configuration for the stream session's virtual monitor.
" } } }, "StreamClass":{ "type":"string", "enum":[ "gen4n_high", "gen4n_ultra", "gen4n_win2022", "gen5n_high", "gen5n_ultra", "gen5n_win2022", "gen6n_small", "gen6n_medium", "gen6n_high", "gen6n_ultra", "gen6n_ultra_win2022", "gen6n_pro", "gen6n_pro_win2022", "gen6n_small_win2022", "gen6n_medium_win2022", "gen6e_pro", "gen6e_pro_win2022" ] }, "StreamGroupLocationStatus":{ "type":"string", "enum":[ "ACTIVATING", "ACTIVE", "ERROR", "REMOVING" ] }, "StreamGroupStatus":{ "type":"string", "enum":[ "ACTIVATING", "UPDATING_LOCATIONS", "ACTIVE", "ACTIVE_WITH_ERRORS", "ERROR", "DELETING", "EXPIRED" ] }, "StreamGroupStatusReason":{ "type":"string", "enum":[ "internalError", "noAvailableInstances" ] }, "StreamGroupSummary":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"Identifier", "documentation":"An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
An ID that uniquely identifies the stream group resource. Example ID: sg-1AB2C3De4.
A descriptive label for the stream group.
" }, "DefaultApplication":{ "shape":"DefaultApplication", "documentation":"Object that identifies the Amazon GameLift Streams application to stream with this stream group.
" }, "StreamClass":{ "shape":"StreamClass", "documentation":"The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
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).
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).
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup.
" }, "StreamGroupSummaryList":{ "type":"list", "member":{"shape":"StreamGroupSummary"} }, "StreamSessionAccessNotReadyException":{ "type":"structure", "required":["Message"], "members":{ "Message":{ "shape":"String", "documentation":"Description of the error.
" } }, "documentation":"The terminal connection to the stream session is not yet available. Wait before retrying the request.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "StreamSessionStatus":{ "type":"string", "enum":[ "ACTIVATING", "ACTIVE", "CONNECTED", "PENDING_CLIENT_RECONNECTION", "RECONNECTING", "TERMINATING", "TERMINATED", "ERROR" ] }, "StreamSessionStatusReason":{ "type":"string", "enum":[ "internalError", "invalidSignalRequest", "placementTimeout", "applicationLogS3DestinationError", "assumeRoleFailed", "applicationExit", "connectionTimeout", "reconnectionTimeout", "maxSessionLengthTimeout", "idleTimeout", "apiTerminated" ] }, "StreamSessionStreamUrl":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "StreamSessionSummary":{ "type":"structure", "members":{ "Arn":{ "shape":"Arn", "documentation":"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.
An opaque, unique identifier for an end-user, defined by the developer.
" }, "Status":{ "shape":"StreamSessionStatus", "documentation":"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.
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.
The data transfer protocol in use with the stream session.
" }, "LastUpdatedAt":{ "shape":"Timestamp", "documentation":"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).
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).
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Provides details about the stream session's exported files.
" }, "Location":{ "shape":"LocationName", "documentation":"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.
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.
" } }, "documentation":"Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
" }, "StreamSessionSummaryList":{ "type":"list", "member":{"shape":"StreamSessionSummary"} }, "StreamUrl":{"type":"string"}, "StreamUrlStatus":{ "type":"string", "enum":[ "ACTIVE", "EXPIRED", "REVOKED", "LIMIT_REACHED" ] }, "StreamUrlStatusReason":{ "type":"string", "enum":[ "userRevoked", "revokedAndTerminatingSessions", "revokedAndSessionsTerminated", "streamGroupDeleted", "applicationDeleted" ] }, "StreamUrlSummary":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"Arn", "documentation":"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].
The unique identifier for the stream URL resource, for example su-1AB2C3De4.
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":{ "shape":"StreamUrlStatus", "documentation":"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.
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.
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).
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).
The maximum number of times the stream URL can start a stream session.
" }, "RemainingUses":{ "shape":"RemainingUses", "documentation":"The number of times the stream URL can still be used to start a stream session.
" }, "StreamGroupArn":{ "shape":"Arn", "documentation":"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.
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.
The maximum length of time, in seconds, that a stream session started from this stream URL can run.
" }, "Description":{ "shape":"Description", "documentation":"The descriptive label for the stream URL.
" } }, "documentation":"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.
" }, "StreamUrlSummaryList":{ "type":"list", "member":{"shape":"StreamUrlSummary"} }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to apply tags to.
", "location":"uri", "locationName":"ResourceArn" }, "Tags":{ "shape":"Tags", "documentation":"A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Tags":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TargetIdleCapacity":{ "type":"integer", "box":true, "min":0 }, "TerminateStreamSessionInput":{ "type":"structure", "required":[ "Identifier", "StreamSessionIdentifier" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":" 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 group that runs this stream session.
", "location":"uri", "locationName":"Identifier" }, "StreamSessionIdentifier":{ "shape":"Identifier", "documentation":" Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.
Description of the error.
" } }, "documentation":"The request was denied due to request throttling. Retry the request after the suggested wait time.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":true} }, "Timestamp":{"type":"timestamp"}, "TokenValue":{ "type":"string", "max":1024, "min":0, "sensitive":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to remove tags from.
", "location":"uri", "locationName":"ResourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"A list of tag keys to remove from the specified Amazon GameLift Streams resource.
", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UpdateApplicationInput":{ "type":"structure", "required":["Identifier"], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"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.
A human-readable label for the application.
" }, "ApplicationLogPaths":{ "shape":"FilePaths", "documentation":"Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location, or relative to the user's home directory when using a supported path variable. You can specify up to 10 log paths. Each individual log file cannot exceed 50 MB in size.
Each path can be a directory or an exact file path. When you specify a directory, Amazon GameLift Streams collects only files with the following extensions: .txt, .log, and .utrace. To collect files with other extensions, specify the exact file path. The copy operation is not performed recursively in subfolders.
The following path variables are recognized when they appear as the first component of a path: %USERPROFILE% (Windows and Proton), $HOME or ~ (Linux). Use a path variable when your application writes logs outside of the application directory.
Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.
The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.
The Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].
A human-readable label for the application. You can edit this value.
" }, "RuntimeEnvironment":{ "shape":"RuntimeEnvironment", "documentation":"Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.
A runtime environment can be one of the following:
For Linux applications
Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)
For Windows applications
Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)
Proton 10.0-4 (Type=PROTON, Version=20260204)
Proton 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
The relative path and file name of the executable file that launches the content for streaming.
" }, "ApplicationLogPaths":{ "shape":"FilePaths", "documentation":"Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.
An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.
The original Amazon S3 location of uploaded stream content for the application.
" }, "Id":{ "shape":"Id", "documentation":"A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.
The current status of the application resource. Possible statuses include the following:
INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.
PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.
READY: The application is ready to deploy in a stream group.
ERROR: An error occurred when setting up the application. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the application.
A short description of the status reason when the application is in ERROR status.
A set of replication statuses for each location.
" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"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).
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).
A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.
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.
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.
A set of one or more locations and the streaming capacity for each location.
" }, "Description":{ "shape":"Description", "documentation":"A descriptive label for the stream group.
" }, "DefaultApplicationIdentifier":{ "shape":"Identifier", "documentation":"The unique identifier of the Amazon GameLift Streams application that you want to set as the default application in a stream group. The application that you specify must be in READY status. The default application is pre-cached on always-on compute resources, reducing stream startup times. Other applications are automatically cached as needed.
Note that this parameter only sets the default application in a stream group. To associate a new application to an existing stream group, you must use AssociateApplications.
When you switch default applications in a stream group, it can take up to a few hours for the new default application to be pre-cached.
This value is 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.
The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
A descriptive label for the stream group.
" }, "DefaultApplication":{ "shape":"DefaultApplication", "documentation":"The default Amazon GameLift Streams application that is associated with this stream group.
" }, "LocationStates":{ "shape":"LocationStates", "documentation":"This value is set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.
ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
The target stream quality for the stream group.
A stream class can be one of the following:
gen6n_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 64 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra_win2022 (NVIDIA, ultra) Supports applications with high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen6n_medium (NVIDIA, medium) Supports applications with moderate 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 6 GB VRAM
Tenancy: Supports up to 4 concurrent stream sessions
gen6n_small (NVIDIA, small) Supports applications with lightweight 3D scene complexity and low CPU usage. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 1 vCPUs, 4 GB RAM, 2 GB VRAM
Tenancy: Supports up to 12 concurrent stream sessions
gen6n_medium_win2022 (NVIDIA, medium) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 6 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6n_small_win2022 (NVIDIA, small) Supports applications with low 3D scene complexity. Powered by NVIDIA L4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 2 vCPUs, 8 GB RAM, 3 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro_win2022 (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen6e_pro (NVIDIA, pro) Supports applications with extremely high 3D scene complexity which require maximum resources. Powered by NVIDIA L40S Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 16 vCPUs, 128 GB RAM, 48 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Powered by NVIDIA A10G Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.6, 32 and 64-bit applications, and anti-cheat technology. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
Tenancy: Supports up to 2 concurrent stream sessions
gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Powered by NVIDIA T4 Tensor Core GPUs.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
The current status of the stream group resource. Possible statuses include the following:
ACTIVATING: The stream group is deploying and isn't ready to host streams.
ACTIVE: The stream group is ready to host streams.
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
ERROR: An error occurred when the stream group deployed. See StatusReason (returned by CreateStreamGroup, GetStreamGroup, and UpdateStreamGroup) for more information.
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of ExpiresAt. Create a new stream group to resume streaming capabilities.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:
internalError: The request can't process right now because of an issue with the server. Try again later.
noAvailableInstances: Amazon GameLift Streams does not currently have enough available capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
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).
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).
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
A set of applications that this stream group is associated with. You can stream any of these applications with the stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
Description of the error.
" } }, "documentation":"One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "VpcId":{ "type":"string", "max":32, "min":1 }, "VpcTransitConfiguration":{ "type":"structure", "required":[ "VpcId", "Ipv4CidrBlocks" ], "members":{ "VpcId":{ "shape":"VpcId", "documentation":"The ID of the Amazon VPC that you want to connect to the stream group. The VPC must be in the same Amazon Web Services account as the stream group. This value cannot be changed after the stream group is created.
" }, "Ipv4CidrBlocks":{ "shape":"Ipv4CidrBlockList", "documentation":"A list of IPv4 CIDR blocks in your VPC that you want the stream group to be able to access. You can specify up to 5 CIDR blocks. The CIDR blocks must be valid subsets of the VPC's CIDR blocks and cannot overlap with the service VPC CIDR block.
" } }, "documentation":"Configuration for connecting a stream group location to resources in your Amazon VPC using AWS Transit Gateway. When you specify a VPC transit configuration, Amazon GameLift Streams creates a Transit Gateway and shares it with your account using AWS Resource Access Manager. After the stream group is active, you must complete the setup by accepting the resource share, creating a VPC attachment, and configuring routing.
" }, "VpcTransitConfigurationResponse":{ "type":"structure", "members":{ "VpcId":{ "shape":"VpcId", "documentation":"The ID of the Amazon VPC that is connected to the stream group.
" }, "Ipv4CidrBlocks":{ "shape":"Ipv4CidrBlockList", "documentation":"The IPv4 CIDR blocks in your VPC that the stream group can access.
" }, "TransitGatewayId":{ "shape":"String", "documentation":"The ID of the Transit Gateway that Amazon GameLift Streams created for this VPC connection. Use this ID when creating your VPC attachment.
" }, "TransitGatewayResourceShareArn":{ "shape":"String", "documentation":"The ARN of the AWS Resource Access Manager resource share for the Transit Gateway. You must accept this resource share before you can create a VPC attachment.
" } }, "documentation":"The VPC transit configuration details for a stream group location, including the Transit Gateway information needed to complete the VPC attachment setup.
" }, "WebSdkProtocolUrl":{"type":"string"} }, "documentation":"Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.
This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS.
See the Amazon GameLift Streams Developer Guide for more information on how Amazon GameLift Streams works and how to work with it.
" }