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.
", "operations": { "AddStreamGroupLocations": "Add locations that can host stream sessions. 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": "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.
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.
Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations.
Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand:
Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.
On-demand: 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.
To adjust the capacity of any ACTIVE stream group, call UpdateStreamGroup.
If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to ACTIVATING. When the stream group reaches ACTIVE status, you can start stream sessions by using StartStreamSession. To check the stream group's status, call GetStreamGroup.
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.
", "DeleteApplication": "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.
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.
", "GetApplication": "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.
", "GetStreamGroup": "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.
", "GetStreamSession": "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.
", "ListApplications": "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.
", "ListStreamGroups": "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.
", "ListStreamSessions": "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.
", "ListStreamSessionsByAccount": "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.
", "ListTagsForResource": "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
", "RemoveStreamGroupLocations": "Removes a set of remote locations from this stream group. Amazon GameLift Streams works to release allocated compute resources in these location. Thus, stream sessions can no longer start from these locations by using this stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal S3 bucket at this location.
You cannot remove the region where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero.
", "StartStreamSession": "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 state
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.
Idle timeout: A stream session will be terminated if no user input has been received for 60 minutes.
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": "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
", "TerminateStreamSession": "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.
", "UpdateApplication": " 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": "Updates the configuration settings for an Amazon GameLift Streams stream group resource. 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. There are two types of capacity, always-on and on-demand:
Always-on: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.
On-demand: 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.
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.
" }, "shapes": { "AccessDeniedException": { "base": "You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
", "refs": {} }, "AddStreamGroupLocationsInput": { "base": null, "refs": {} }, "AddStreamGroupLocationsOutput": { "base": null, "refs": {} }, "AlwaysOnCapacity": { "base": null, "refs": { "LocationConfiguration$AlwaysOnCapacity": "The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.
", "LocationState$AlwaysOnCapacity": "The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 when creating a stream group or adding a location.
" } }, "ApplicationLogOutputUri": { "base": null, "refs": { "CreateApplicationInput$ApplicationLogOutputUri": "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.
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.
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.
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.
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 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.
The original Amazon S3 location of uploaded stream content for the application.
", "GetApplicationOutput$ApplicationSourceUri": "The original Amazon S3 location of uploaded stream content for the application.
", "UpdateApplicationOutput$ApplicationSourceUri": "The original Amazon S3 location of uploaded stream content for the application.
" } }, "ApplicationStatus": { "base": null, "refs": { "ApplicationSummary$Status": "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.
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.
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.
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 short description of the status reason when the application is in ERROR status.
A short description of the status reason when the application is in ERROR status.
Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication.
", "refs": { "ApplicationSummaryList$member": null } }, "ApplicationSummaryList": { "base": null, "refs": { "ListApplicationsOutput$Items": "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.
" } }, "Arn": { "base": null, "refs": { "ArnList$member": null, "AssociateApplicationsOutput$Arn": "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.
An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/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.
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].
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.
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.
", "StartStreamSessionOutput$Arn": "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].
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.
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 Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to apply tags to.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the Amazon GameLift Streams resource that you want to remove tags from.
" } }, "ArnList": { "base": null, "refs": { "AssociateApplicationsOutput$ApplicationArns": "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.
A newly created application is not associated to any stream groups. This value is empty.
", "CreateStreamGroupOutput$AssociatedApplications": "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.
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.
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.
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.
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.
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.
This value is the total number of compute resources that you request for a stream group. This includes resources that Amazon GameLift Streams has either already provisioned or is working to provision. You request capacity for each location in a stream group.
", "LocationState$AllocatedCapacity": "This value is the number of compute resources that a stream group has provisioned and is ready to stream. It includes resources that are currently streaming and resources that are idle and ready to respond to stream requests.
", "LocationState$IdleCapacity": "This value is the amount of allocated capacity that is not currently streaming. It represents the stream group's availability to respond to new stream requests, but not including on-demand capacity.
" } }, "ClientToken": { "base": null, "refs": { "CreateApplicationInput$ClientToken": "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.
", "CreateStreamGroupInput$ClientToken": "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.
", "CreateStreamSessionConnectionInput$ClientToken": "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.
", "StartStreamSessionInput$ClientToken": "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.
" } }, "ConflictException": { "base": "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.
", "refs": {} }, "ConnectionTimeoutSeconds": { "base": null, "refs": { "GetStreamSessionOutput$ConnectionTimeoutSeconds": "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.
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 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.
Represents the default Amazon GameLift Streams application that a stream group hosts.
", "refs": { "CreateStreamGroupOutput$DefaultApplication": "The default Amazon GameLift Streams application that is associated with this stream group.
", "GetStreamGroupOutput$DefaultApplication": "The default Amazon GameLift Streams application that is associated with this stream group.
", "StreamGroupSummary$DefaultApplication": "Object that identifies the Amazon GameLift Streams application to stream with this stream group.
", "UpdateStreamGroupOutput$DefaultApplication": "The default Amazon GameLift Streams application that is associated with this stream group.
" } }, "DeleteApplicationInput": { "base": null, "refs": {} }, "DeleteStreamGroupInput": { "base": null, "refs": {} }, "Description": { "base": null, "refs": { "ApplicationSummary$Description": "A human-readable label for the application. You can edit this value.
", "CreateApplicationInput$Description": "A human-readable label for the application. You can update this value later.
", "CreateApplicationOutput$Description": "A human-readable label for the application. You can edit this value.
", "CreateStreamGroupInput$Description": "A descriptive label for the stream group.
", "CreateStreamGroupOutput$Description": "A descriptive label for the stream group.
", "GetApplicationOutput$Description": "A human-readable label for the application. You can edit this value.
", "GetStreamGroupOutput$Description": "A descriptive label for the stream group.
", "GetStreamSessionOutput$Description": "A human-readable label for the stream session. You can update this value at any time.
", "StartStreamSessionInput$Description": "A human-readable label for the stream session. You can update this value later.
", "StartStreamSessionOutput$Description": "A human-readable label for the stream session. You can update this value at any time.
", "StreamGroupSummary$Description": "A descriptive label for the stream group.
", "UpdateApplicationInput$Description": "A human-readable label for the application.
", "UpdateApplicationOutput$Description": "A human-readable label for the application. You can edit this value.
", "UpdateStreamGroupInput$Description": "A descriptive label for the stream group.
", "UpdateStreamGroupOutput$Description": "A descriptive label for the stream group.
" } }, "DisassociateApplicationsInput": { "base": null, "refs": {} }, "DisassociateApplicationsOutput": { "base": null, "refs": {} }, "EnvironmentVariables": { "base": null, "refs": { "GetStreamSessionOutput$AdditionalEnvironmentVariables": "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.
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.
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 path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in ApplicationSourceUri.
The path and file name of the executable file that launches the content for streaming.
", "GetApplicationOutput$ExecutablePath": "The path and file name of the executable file that launches the content for streaming.
", "UpdateApplicationOutput$ExecutablePath": "The path and file name of the executable file that launches the content for streaming.
" } }, "ExportFilesMetadata": { "base": "Provides details about the stream session's exported files.
", "refs": { "GetStreamSessionOutput$ExportFilesMetadata": "Provides details about the stream session's exported files.
", "StartStreamSessionOutput$ExportFilesMetadata": "Provides details about the stream session's exported files.
", "StreamSessionSummary$ExportFilesMetadata": "Provides details about the stream session's exported files.
" } }, "ExportFilesReason": { "base": null, "refs": { "ExportFilesMetadata$StatusReason": "A short description of the reason the export is in FAILED status.
The result of the ExportStreamSessionFiles operation.
", "ListStreamSessionsByAccountInput$ExportFilesStatus": "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.
", "ListStreamSessionsInput$ExportFilesStatus": "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.
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.
", "StartStreamSessionOutput$LogFileLocationUri": "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.
" } }, "FilePath": { "base": null, "refs": { "FilePaths$member": null } }, "FilePaths": { "base": null, "refs": { "CreateApplicationInput$ApplicationLogPaths": "Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location. You can specify up to 10 log paths. 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.
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.
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.
Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location. You can specify up to 10 log paths. 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.
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.
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 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 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.
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.
A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.
An ID that uniquely identifies the stream group resource. Example ID: sg-1AB2C3De4.
A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.
A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
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.
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) 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].
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.
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].
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.
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].
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.
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.
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 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].
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].
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 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).
", "RemoveStreamGroupLocationsInput$Identifier": "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.
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.
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) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.
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.
", "TerminateStreamSessionInput$StreamSessionIdentifier": " 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 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].
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 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 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 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.
The service encountered an internal error and is unable to complete the request.
", "refs": {} }, "ListApplicationsInput": { "base": null, "refs": {} }, "ListApplicationsOutput": { "base": null, "refs": {} }, "ListStreamGroupsInput": { "base": null, "refs": {} }, "ListStreamGroupsOutput": { "base": null, "refs": {} }, "ListStreamSessionsByAccountInput": { "base": null, "refs": {} }, "ListStreamSessionsByAccountOutput": { "base": null, "refs": {} }, "ListStreamSessionsInput": { "base": null, "refs": {} }, "ListStreamSessionsOutput": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "LocationConfiguration": { "base": "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.
", "refs": { "LocationConfigurations$member": null } }, "LocationConfigurations": { "base": null, "refs": { "AddStreamGroupLocationsInput$LocationConfigurations": "A set of one or more locations and the streaming capacity for each location.
", "CreateStreamGroupInput$LocationConfigurations": "A set of one or more locations and the streaming capacity for each location.
", "UpdateStreamGroupInput$LocationConfigurations": "A set of one or more locations and the streaming capacity for each location.
" } }, "LocationList": { "base": null, "refs": { "StartStreamSessionInput$Locations": " 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.
" } }, "LocationName": { "base": null, "refs": { "GetStreamSessionOutput$Location": "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.
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.
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.
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 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 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.
Represents a location and its corresponding stream capacity and status.
", "refs": { "LocationStates$member": null } }, "LocationStates": { "base": null, "refs": { "AddStreamGroupLocationsOutput$Locations": "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 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.
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.
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.
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.
" } }, "MaxResults": { "base": null, "refs": { "ListApplicationsInput$MaxResults": "The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
The number of results to return. Use this parameter with NextToken to return results in sequential pages. Default value is 25.
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.
", "ListApplicationsOutput$NextToken": "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$NextToken": "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.
", "ListStreamGroupsOutput$NextToken": "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$NextToken": "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.
", "ListStreamSessionsByAccountOutput$NextToken": "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$NextToken": "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.
", "ListStreamSessionsOutput$NextToken": "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.
" } }, "OnDemandCapacity": { "base": null, "refs": { "LocationConfiguration$OnDemandCapacity": "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.
", "LocationState$OnDemandCapacity": "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.
" } }, "OutputUri": { "base": null, "refs": { "ExportFilesMetadata$OutputUri": " 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.
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.
The data transfer protocol in use with the stream session.
", "StartStreamSessionInput$Protocol": "The data transport protocol to use for the stream session.
", "StartStreamSessionOutput$Protocol": "The data transfer protocol in use with the stream session.
", "StreamSessionSummary$Protocol": "The data transfer protocol in use with the stream session.
" } }, "RemoveStreamGroupLocationsInput": { "base": null, "refs": {} }, "ReplicationStatus": { "base": "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.
", "refs": { "ReplicationStatuses$member": null } }, "ReplicationStatusType": { "base": null, "refs": { "ReplicationStatus$Status": "The current status of the replication process.
" } }, "ReplicationStatuses": { "base": null, "refs": { "CreateApplicationOutput$ReplicationStatuses": "A set of replication statuses for each location.
", "GetApplicationOutput$ReplicationStatuses": "A set of replication statuses for each location.
", "UpdateApplicationOutput$ReplicationStatuses": "A set of replication statuses for each location.
" } }, "ResourceNotFoundException": { "base": "The resource specified in the request was not found. Correct the request before you try again.
", "refs": {} }, "RuntimeEnvironment": { "base": "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 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
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 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
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 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
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 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
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 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
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 9.0-2 (Type=PROTON, Version=20250516)
Proton 8.0-5 (Type=PROTON, Version=20241007)
Proton 8.0-2c (Type=PROTON, Version=20230704)
The operating system and other drivers. For Proton, this also includes the Proton compatibility layer.
" } }, "RuntimeEnvironmentVersion": { "base": null, "refs": { "RuntimeEnvironment$Version": "Versioned container environment for the application operating system.
" } }, "ServiceQuotaExceededException": { "base": "The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.
", "refs": {} }, "SessionLengthSeconds": { "base": null, "refs": { "GetStreamSessionOutput$SessionLengthSeconds": "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.
", "StartStreamSessionInput$SessionLengthSeconds": "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).
", "StartStreamSessionOutput$SessionLengthSeconds": "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.
" } }, "SignalRequest": { "base": null, "refs": { "CreateStreamSessionConnectionInput$SignalRequest": "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 ICE offer string that a client generates to initiate a connection to the stream session.
", "StartStreamSessionInput$SignalRequest": "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.
", "StartStreamSessionOutput$SignalRequest": "The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.
" } }, "SignalResponse": { "base": null, "refs": { "CreateStreamSessionConnectionOutput$SignalResponse": "The WebRTC answer string that the stream server generates in response to the SignalRequest.
The WebRTC answer string that the stream server generates in response to the SignalRequest.
The WebRTC answer string that the stream server generates in response to the SignalRequest.
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:
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
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. Uses NVIDIA A10G Tensor GPU.
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. Uses dedicated NVIDIA A10G Tensor GPU.
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
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. Uses NVIDIA T4 Tensor GPU.
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. Uses dedicated NVIDIA T4 Tensor GPU.
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 target stream quality for the stream group.
A stream class can be one of the following:
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
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. Uses NVIDIA A10G Tensor GPU.
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. Uses dedicated NVIDIA A10G Tensor GPU.
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
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. Uses NVIDIA T4 Tensor GPU.
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. Uses dedicated NVIDIA T4 Tensor GPU.
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 target stream quality for the stream group.
A stream class can be one of the following:
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
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. Uses NVIDIA A10G Tensor GPU.
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. Uses dedicated NVIDIA A10G Tensor GPU.
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
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. Uses NVIDIA T4 Tensor GPU.
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. Uses dedicated NVIDIA T4 Tensor GPU.
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 target stream quality for the stream group.
A stream class can be one of the following:
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
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. Uses NVIDIA A10G Tensor GPU.
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. Uses dedicated NVIDIA A10G Tensor GPU.
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
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. Uses NVIDIA T4 Tensor GPU.
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. Uses dedicated NVIDIA T4 Tensor GPU.
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 target stream quality for the stream group.
A stream class can be one of the following:
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.
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. Uses NVIDIA A10G Tensor GPU.
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. Uses dedicated NVIDIA A10G Tensor GPU.
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.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.
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. Uses NVIDIA T4 Tensor GPU.
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. Uses dedicated NVIDIA T4 Tensor GPU.
Reference resolution: 1080p
Reference frame rate: 60 fps
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
Tenancy: Supports 1 concurrent stream session
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 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.
ERROR: An error occurred when the stream group deployed. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
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.
ERROR: An error occurred when the stream group deployed. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
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.
ERROR: An error occurred when the stream group deployed. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
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.
ERROR: An error occurred when the stream group deployed. See StatusReason for more information.
DELETING: Amazon GameLift Streams is in the process of deleting the stream group.
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 on-demand 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 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 on-demand 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 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 on-demand 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.
Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup.
", "refs": { "StreamGroupSummaryList$member": null } }, "StreamGroupSummaryList": { "base": null, "refs": { "ListStreamGroupsOutput$Items": "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.
" } }, "StreamSessionStatus": { "base": null, "refs": { "GetStreamSessionOutput$Status": "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.
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.
Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.
", "ListStreamSessionsInput$Status": "Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.
", "StartStreamSessionOutput$Status": "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.
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.
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.
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.
A short description of the reason the stream session is in ERROR status.
Describes an Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call GetStreamSession.
", "refs": { "StreamSessionSummaryList$member": null } }, "StreamSessionSummaryList": { "base": null, "refs": { "ListStreamSessionsByAccountOutput$Items": "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.
", "ListStreamSessionsOutput$Items": "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.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$Message": "Description of the error.
", "ConflictException$Message": "Description of the error.
", "GameLaunchArgList$member": null, "InternalServerException$Message": "Description of the error.
", "LocationsList$member": null, "ResourceNotFoundException$Message": "Description of the error.
", "ServiceQuotaExceededException$Message": "Description of the error.
", "ThrottlingException$Message": "Description of the error.
", "ValidationException$Message": "Description of the error.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "Tags$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "A list of tag keys to remove from the specified Amazon GameLift Streams resource.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "CreateApplicationInput$Tags": "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.
", "CreateStreamGroupInput$Tags": "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.
", "ListTagsForResourceResponse$Tags": "A collection of tags that have been assigned to the specified resource.
", "TagResourceRequest$Tags": "A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource.
" } }, "TerminateStreamSessionInput": { "base": null, "refs": {} }, "ThrottlingException": { "base": "The request was denied due to request throttling. Retry the request after the suggested wait time.
", "refs": {} }, "Timestamp": { "base": null, "refs": { "ApplicationSummary$CreatedAt": "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 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 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).
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 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).
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).
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).
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 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).
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 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 opaque, unique identifier for an end-user, defined by the developer.
", "StartStreamSessionInput$UserId": "An opaque, unique identifier for an end-user, defined by the developer.
", "StartStreamSessionOutput$UserId": "An opaque, unique identifier for an end-user, defined by the developer.
", "StreamSessionSummary$UserId": "An opaque, unique identifier for an end-user, defined by the developer.
" } }, "ValidationException": { "base": "One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.
", "refs": {} }, "WebSdkProtocolUrl": { "base": null, "refs": { "GetStreamSessionOutput$WebSdkProtocolUrl": "The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
", "StartStreamSessionOutput$WebSdkProtocolUrl": "The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.
" } } } }