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.

Amazon AppStream REST API

The Amazon AppStream web service provides APIs you can call to manage applications hosted on Amazon AppStream and to manage client sessions connecting to those applications.

You can use this API to:

  • Programmatically manage applications hosted on Amazon AppStream. For example, you can add new applications to Amazon AppStream and automate tasks you would otherwise perform through the console.

  • Create tools or services to control access to your applications. The example found in Building an Entitlement Service demonstrates one such service.

You can call an API provided by Amazon AppStream by either submitting a REST request, or by calling wrapper functions in the Amazon AppStream SDK. You can download the Amazon AppStream SDK from the links in Downloads.

Hypertext Application Language

The Amazon AppStream web service is a resource-based API that uses Hypertext Application Language (HAL). HAL provides a standard way for expressing the resources and relationships of an API as hyperlinks. Using HAL, you use HTTP methods (GET, PUT, POST, DELETE) to submit requests and receive information about the API in the response. Applications can use the information returned to explore the functionality of the API.

For example, you can inspect the JSON returned in the response from the web service on an Application resource to discover the session:entitle link. By extracting the href property of that link, you can programmatically build the request needed to create a new client session for that application. For more information about HAL, see the JSON Hypertext Application Language draft.