View Source AWS.GameLiftStreams (aws-elixir v1.0.7)
Amazon GameLift Streams
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.
Link to this section Summary
Functions
Add locations that can host stream sessions.
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.
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.
Manage how Amazon GameLift Streams streams your applications by using a stream group.
Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.
Permanently deletes an Amazon GameLift Streams application resource.
Permanently deletes all compute resources and information related to a stream group.
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.
Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application.
Retrieves properties for an Amazon GameLift Streams application resource.
Retrieves properties for a Amazon GameLift Streams stream group resource.
Retrieves properties for a Amazon GameLift Streams stream session resource.
Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use.
Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use.
Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.
Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.
Retrieves all tags assigned to a Amazon GameLift Streams resource.
Removes a set of remote locations from this stream group.
This action initiates a new stream session and outputs connection information that clients can use to access the stream.
Assigns one or more tags to a Amazon GameLift Streams resource.
Permanently terminates an active stream session.
Removes one or more tags from a Amazon GameLift Streams resource.
Updates the mutable configuration settings for a Amazon GameLift Streams application resource.
Updates the configuration settings for an Amazon GameLift Streams stream group resource.
Link to this section Functions
add_stream_group_locations(client, identifier, input, options \\ [])
View SourceAdd 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.
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.
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.
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).
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.
create_stream_session_connection(client, identifier, stream_session_identifier, input, options \\ [])
View SourceAllows clients to reconnect to a recently disconnected stream session without losing any data from the last session.
A client can reconnect to a stream session that's in
PENDING_CLIENT_RECONNECTION
or ACTIVE
status. In the stream session life
cycle, when the client disconnects from the stream session, the stream session
transitions from CONNECTED
to PENDING_CLIENT_RECONNECTION
status. When a
client requests to reconnect by calling CreateStreamSessionConnection
, the
stream session transitions to RECONNECTING
status. When the reconnection is
successful, the stream session transitions to ACTIVE
status. After a stream
session is disconnected for longer than ConnectionTimeoutSeconds
, the stream
session transitions to the TERMINATED
status.
To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream.
ConnectionTimeoutSeconds
defines the amount of time after the stream session
disconnects that a reconnection is allowed. If a client is disconnected from the
stream for longer than ConnectionTimeoutSeconds
, the stream session ends.
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
orERROR
status. You cannot delete an application that's inPROCESSING
orINITIALIZED
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.
disassociate_applications(client, identifier, input, options \\ [])
View SourceWhen 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 using this stream group. The disassociate action does not affect the stream capacity of a stream group.
You can only disassociate an application if it's not a default application of
the stream group. Check DefaultApplicationIdentifier
by calling
GetStreamGroup.
export_stream_session_files(client, identifier, stream_session_identifier, input, options \\ [])
View SourceExport 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.
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.
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.
get_stream_session(client, identifier, stream_session_identifier, options \\ [])
View SourceRetrieves 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.
list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves 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.
list_stream_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves 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.
list_stream_sessions(client, identifier, export_files_status \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceRetrieves 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.
list_stream_sessions_by_account(client, export_files_status \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceRetrieves 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.
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
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
remove_stream_group_locations(client, identifier, input, options \\ [])
View SourceRemoves 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.
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.
To start a new stream session, specify a stream group and application ID, along with the transport protocol and signal request settings to use with the stream. You must have associated at least one application to the stream group before starting a stream session, either when creating the stream group, or by using AssociateApplications.
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 in a remote location before the remote location can
host a stream.
If the request is successful, Amazon GameLift Streams begins to prepare the
stream. Amazon GameLift Streams assigns an Amazon Resource Name (ARN) value to
the stream session resource and sets the status to ACTIVATING
. During the
stream preparation process, Amazon GameLift Streams queues the request and
searches for available stream capacity to run the stream. This results in one of
the following:
Amazon GameLift Streams identifies an available compute resource to run the application content and start the stream. When the stream is ready, the stream session's status changes to
ACTIVE
and includes stream connection information. Provide the connection information to the requesting client to join the stream session.Amazon GameLift Streams doesn't identify an available resource within a certain time, set by
ClientToken
. In this case, Amazon GameLift Streams stops processing the request, and the stream session object status changes toERROR
with status reasonplacementTimeout
.
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
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
terminate_stream_session(client, identifier, stream_session_identifier, input, options \\ [])
View SourcePermanently 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.
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.
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.
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).
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.