AWS gameliftstreams documentation change
Summary
Added API reference links, clarified error handling documentation, and improved state transition descriptions
Security assessment
Changes improve general documentation accuracy and error troubleshooting guidance, but do not address security vulnerabilities or introduce security-related content
Diff
diff --git a/gameliftstreams/latest/developerguide/stream-sessions.md b/gameliftstreams/latest/developerguide/stream-sessions.md index 586b36fba..f6d680fe6 100644 --- a//gameliftstreams/latest/developerguide/stream-sessions.md +++ b//gameliftstreams/latest/developerguide/stream-sessions.md @@ -17 +17 @@ The prerequisites to start a stream session are an application and a stream grou -When you successfully start a stream session, you receive a unique identifier for that stream session. Then, you use that ID to connect the stream session to an end user. For more information, refer to `StartStreamSession` in the Amazon GameLift Streams API Reference. +When you successfully start a stream session, you receive a unique identifier for that stream session. Then, you use that ID to connect the stream session to an end user. For more information, refer to [StartStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html) in the _Amazon GameLift Streams API Reference_. @@ -58 +58 @@ When working with stream sessions in Amazon GameLift Streams, this diagram can h - * `StartStreamSession` creates a new stream session, which begins in `ACTIVATING` state. When Amazon GameLift Streams finds available resources to host the stream, the stream session transitions to `ACTIVE`. When a client connects to the active stream, the stream session transitions to `CONNECTED`. + * [StartStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html) creates a new stream session, which begins in `ACTIVATING` state. When Amazon GameLift Streams finds available resources to host the stream, the stream session transitions to `ACTIVE`. When a client connects to the active stream, the stream session transitions to `CONNECTED`. @@ -60 +60 @@ When working with stream sessions in Amazon GameLift Streams, this diagram can h - * When a client disconnects from a stream, the stream session transitions to `PENDING_CLIENT_RECONNECTION` state. `CreateStreamSessionConnection` transitions the stream session to `RECONNECTING`, and will either initiate the client to reconnect to the stream or create a new stream session. When the client reconnects, it transitions back to `CONNECTED`. If a client is disconnected for longer than `ConnectionTimeoutSeconds`, the stream session ends. + * When a client disconnects from a stream, the stream session transitions to `PENDING_CLIENT_RECONNECTION` state. [CreateStreamSessionConnection](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html) transitions the stream session to `RECONNECTING`, and will either initiate the client to reconnect to the stream or create a new stream session. When the client reconnects, it transitions back to `CONNECTED`. If a client is disconnected for longer than `ConnectionTimeoutSeconds`, the stream session ends. @@ -64 +64 @@ When working with stream sessions in Amazon GameLift Streams, this diagram can h - * `TerminateStreamSession` initiates termination of the stream, and the stream session transitions to `TERMINATING` state. When the stream session terminates successfully, it transitions to `TERMINATED`. + * [TerminateStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TerminateStreamSession.html) initiates termination of the stream, and the stream session transitions to `TERMINATING` state. When the stream session terminates successfully, it transitions to `TERMINATED`. @@ -66 +66 @@ When working with stream sessions in Amazon GameLift Streams, this diagram can h - * A stream session in any state, except `TERMINATED`, can transition to `ERROR`. You can find additional details about the error in Amazon GameLift Streams Console or CLI. + * A stream session in any state, except `TERMINATED`, can transition to `ERROR`. When an API call returns `ERROR` as a Status value, check the value of StatusReason for a short description of the cause of the error. You can also call [GetStreamSession](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html) to check these values. @@ -77 +77 @@ If you refresh the website, switch browsers, or disconnect from your stream in s -Each stream connection has a unique token that must be specified to reconnect back to that stream. In this Amazon GameLift Streams Web SDK sample web client, the stream's unique token is located in the URL address. For example: `http://localhost:8000/?token=2061cf1b-4bef-bf3e-e39165924480`. +Each stream connection has a unique token that must be specified to reconnect back to that stream. In the Amazon GameLift Streams Web SDK sample web client, the stream's unique token is located in the URL address. For example: `http://localhost:8000/?token=2061cf1b-4bef-bf3e-e39165924480`. @@ -79 +79 @@ Each stream connection has a unique token that must be specified to reconnect ba -For more information, refer to `CreateStreamSessionConnection` in the [Amazon GameLift Streams API Reference](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/). +For more information, refer to [CreateStreamSessionConnection](https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html) in the _Amazon GameLift Streams API Reference_.