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.


An application you have added to Amazon AppStream. You are only able to access applications added to your AWS account.

Relation Description Methods Templated
self An application hosted on Amazon AppStream. GET No.
application:status The current status of this application. GET No.
application:update Update selected metadata for this application. POST No.
application:errors The collection of errors for this application. GET No.
application:archive Archives the application. PUT No.
application:reactivate Activates a previously archived application. PUT No.
application:delete Deletes an application that is in the Error state. DELETE No.
application:sessions The collection of sessions associated with this application. GET No.
session:by-id The session which has the specified identifier. GET Yes. Requires the session identifier.
session:entitle Create a new client session for this application. POST No.
collection The collection of applications you have hosted on Amazon AppStream. The collection includes this application. GET No.


The following properties of the application are set when you create the application, either by using the REST API or the Amazon AppStream console.

Name Description
id The application identifier. This is unique across all your applications in Amazon AppStream.
name The name of the application.
description (Optional) The description of the application. This description is used to describe the application in Amazon AppStream, it is not displayed to end users.
installerUrl A presigned URL that points to the location in Amazon S3 that contains the installation package for the application. For more information on creating a presigned URL, see Share an Object with Others in the Amazon Simple Storage Service Developer Guide.
installerParameters The parameters required by the application installer to install that application on a host managed by Amazon AppStream.
launchCommand The command to run in order to launch the application after it is hosted on Amazon AppStream.


This command should not should include any command-line parameters.

logBucket The name of the Amazon S3 bucket where the .zip files contains the logs are uploaded. The bucket must already exist and allow Amazon AppStream to use the PutObject method.
logPaths A string array whose elements contain the log filenames or directory path where logs are stored. The filenames and paths must meet the following requirements:
  • Log files must be located in the C:\ directory.

  • Log paths must be fully qualified paths. Do not use relative paths. You can use wildcards.

  • Log paths must be less than the path length limits. See Naming Files, Paths, and Namespaces.

  • Log file names cannot contain Windows reserved characters. See Naming Conventions.

  • Your application must have read access to the paths.


The total size of logs in the .zip file is subject to the Amazon S3 key size limits.

applicationErrorCount The total number of errors associated with this application. This does not include errors associated with client sessions, which are enumerated in sessionErrorCount.
activeSessions The total number of client sessions currently connected to this application.
availableSessions The additional capacity available to accept client sessions.
sessionErrorCount The total number of errors associated with client sessions connected to this application.
createdDate The date the application was created, in ISO 8601 format.
lastUpdatedDate The date the application metadata was last updated in Amazon AppStream, in ISO 8601 format.

On this page: