Menu
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.

session:entitle

You can use a POST request and this API to entitle a new session for the current application. Amazon AppStream returns the identifier of the newly created session. The new session contains the entitlementUrl property which your entitlement service should pass back to the client. The client will then use this URL to redeem its entitlement from Amazon AppStream and get the IP address it will use to connect to the application.

Relation Description Methods Templated
self The session:entitle link relation. POST No.

Input

When you entitle a new session, you can pass in the following field during your POST request.

Input Field Description
opaqueData (Optional) 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.

Output

The newly entitled Session.

On this page: