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.

Application Status

The current status of an application hosted on Amazon AppStream.

Relation Description Methods Templated
self The status of an application. GET No.
up The application to which this status applies. GET No.


Name Description
state The state of the current application. This can be one of the following values:
  • Active—The application is ready to accept client sessions.

  • Archived—The application must be reactivated before accepting client sessions.

  • Archiving—The application is in the process of archiving. No new sessions can be entitled, but existing sessions will continue until these sessions finish. To end the existing sessions, explicitly terminate the existing session.

  • Blocked—The application is waiting on dependencies.

  • Building—Amazon AppStream is allocating resources to host the application.

  • Deleting—The application is in the process of being deleted.

  • Error—The application failed to build or deploy properly.

  • New—The application has just been created.

  • Unknown—The application state cannot be determined.

buildStep This property is present when the state is either Building or Error. It indicates either the currently processing step if the state is Building, or the step that was processing if the state is Error. It can be one of the following values:
  • Copying—Copying the installer data into the hosting environment.

  • Installing—Installing the application into the hosting environment.

  • Preparing—Preparing the host environment for application installation.

  • Provisioning—Provisioning the hosting environment to run your application.

On this page: