Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425133268.7 KB

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.

get/streamgroups/{Identifier}/streamsessions

Path parameters

Identifierstring required

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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a>.

Query parameters

Status'ACTIVATING' | 'ACTIVE' | 'CONNECTED' | 'PENDING_CLIENT_RECONNECTION' | 'RECONNECTING' | 'TERMINATING' | 'TERMINATED' | 'ERROR'

Filter by the stream session status. You can specify one status in each request to retrieve only sessions that are currently in that status.

ExportFilesStatus'SUCCEEDED' | 'FAILED' | 'PENDING'
<p>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.</p> <p> Exported files can be in one of the following states: </p> <ul> <li> <p> <code>SUCCEEDED</code>: The exported files are successfully stored in an S3 bucket.</p> </li> <li> <p> <code>FAILED</code>: The session ended but Amazon GameLift Streams couldn't collect and upload the files to S3.</p> </li> <li> <p> <code>PENDING</code>: Either the stream session is still in progress, or uploading the exported files to the S3 bucket is in progress.</p> </li> </ul>
NextTokenstring

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.

MaxResultsinteger

The number of results to return. Use this parameter with <code>NextToken</code> to return results in sequential pages. Default value is <code>25</code>.

Response

Success

NextTokenstring

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.