Amazon AppStream
Developer Guide

This documentation is for an older version of Amazon AppStream. For information about the latest version, see the Amazon AppStream 2.0 Developer Guide.


A resource representing an individual client session of an application hosted on Amazon AppStream.

Relation Description Methods Templated
self A session of the specified application GET No.
session:status The status of the current session. GET No.
session:terminate Terminate the current session. PUT No.
collection The list of all client sessions for the specified application. GET No.


Name Description
id Unique identifier for the session.
entitlementUrl The URL clients use to redeem an entitlement for this session and connect to the application.
opaqueData Data to pass to the application. This data is not used by the client, entitlement service, or Amazon AppStream, it is used by the application. An example of opaqueData would be a user identifier, which the application would then use to load previous state information (such as high score or current map level) for that user from a database.
errorCount The number of errors associated with this session.
startDate The time at which the session began, in ISO 8601 format.
endDate The time at which the session ended, in ISO 8601 format. If this is null, the session is active and the client is currently connected.

On this page: