Open documentation ↗Overview
<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand. </p> <note> <p>You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html">Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p> </note> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href="http://aws.amazon.com/appstream2">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href="http://aws.amazon.com/documentation/appstream2">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>
Amazon AppStream is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 65 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2016-12-01
- Endpoints
- 65
- OpenAPI
- Specification ↗
- Spec updated
- 2020-02-28
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=PhotonAdminProxyService.AssociateApplicationFleet | Associates the specified application with the specified fleet. This is only supported for Elastic fleets. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.AssociateApplicationToEntitlement | Associates an application to entitle. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.AssociateFleet | Associates the specified fleet with the specified stack. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.BatchAssociateUserStack | Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory d |
| POST | /#X-Amz-Target=PhotonAdminProxyService.BatchDisassociateUserStack | Disassociates the specified users from the specified stacks. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CopyImage | Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateAppBlock | <p>Creates an app block.</p> <p>App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also sto |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateApplication | <p>Creates an application.</p> <p>Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet st |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateDirectoryConfig | Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft A |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateEntitlement | Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federat |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateFleet | Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateImageBuilder | <p>Creates an image builder. An image builder is a virtual machine that is used to create an image.</p> <p>The initial state of the builder is <code>PENDING</co |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateImageBuilderStreamingURL | Creates a URL to start an image builder streaming session. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateStack | Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateStreamingURL | Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without u |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateUpdatedImage | <p>Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.</p> <p>For more information, see the |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateUsageReportSubscription | Creates a usage report subscription. Usage reports are generated daily. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.CreateUser | Creates a new user in the user pool. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteAppBlock | Deletes an app block. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteApplication | Deletes an application. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteDirectoryConfig | Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directo |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteEntitlement | Deletes the specified entitlement. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteFleet | Deletes the specified fleet. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteImage | Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteImageBuilder | Deletes the specified image builder and releases the capacity. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteImagePermissions | Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions c |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteStack | Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteUsageReportSubscription | Disables usage report generation. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DeleteUser | Deletes a user from the user pool. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeAppBlocks | Retrieves a list that describes one or more app blocks. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeApplicationFleetAssociations | Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeApplications | Retrieves a list that describes one or more applications. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeDirectoryConfigs | <p>Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeEntitlements | Retrieves a list that describes one of more entitlements. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeFleets | Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeImageBuilders | Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeImagePermissions | Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeImages | Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeSessions | Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeStacks | Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeUsageReportSubscriptions | Retrieves a list that describes one or more usage report subscriptions. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeUserStackAssociations | <p>Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:</p> <ul> <li> <p>The stack name</p> </li> |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DescribeUsers | Retrieves a list that describes one or more specified users in the user pool. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DisableUser | Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DisassociateApplicationFleet | Disassociates the specified application from the fleet. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DisassociateApplicationFromEntitlement | Deletes the specified application from the specified entitlement. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.DisassociateFleet | Disassociates the specified fleet from the specified stack. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.EnableUser | Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.ExpireSession | Immediately stops the specified streaming session. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.ListAssociatedFleets | Retrieves the name of the fleet that is associated with the specified stack. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.ListAssociatedStacks | Retrieves the name of the stack with which the specified fleet is associated. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.ListEntitledApplications | Retrieves a list of entitled applications. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.ListTagsForResource | <p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more |
| POST | /#X-Amz-Target=PhotonAdminProxyService.StartFleet | Starts the specified fleet. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.StartImageBuilder | Starts the specified image builder. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.StopFleet | Stops the specified fleet. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.StopImageBuilder | Stops the specified image builder. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.TagResource | <p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Ea |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UntagResource | <p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForRes |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UpdateApplication | Updates the specified application. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UpdateDirectoryConfig | Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UpdateEntitlement | Updates the specified entitlement. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UpdateFleet | <p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name.</p> <p>If the flee |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UpdateImagePermissions | Adds or updates permissions for the specified private image. |
| POST | /#X-Amz-Target=PhotonAdminProxyService.UpdateStack | Updates the specified fields for the specified stack. |
Questions
Does the Amazon AppStream API need an API key?
Yes. The Amazon AppStream API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon AppStream API support HTTPS?
Yes, the Amazon AppStream API is served over HTTPS.
How many endpoints does the Amazon AppStream API have?
Its OpenAPI description lists 65 endpoints in version 2016-12-01. All of them are shown on this page.
What are alternatives to the Amazon AppStream API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).