Amazon AppStream
Amazon WorkSpaces Applications This is the Amazon WorkSpaces Applications API Reference . This documentation provides descriptions and syntax for each of the…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon WorkSpaces Applications
This is the Amazon WorkSpaces Applications API Reference . This documentation provides descriptions and syntax for each of the actions and data types in WorkSpaces Applications. WorkSpaces Applications is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. WorkSpaces Applications manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
You can call the WorkSpaces Applications API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access WorkSpaces Applications API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon WorkSpaces Applications Administration Guide .
To learn more about WorkSpaces Applications, see the following resources:
Amazon WorkSpaces Applications product page
Amazon WorkSpaces Applications documentation
Endpoints 90
- POSTAssociate app block builder app block
/#X-Amz-Target=PhotonAdminProxyService.AssociateAppBlockBuilderAppBlockAssociates the specified app block builder with the specified app block. - POSTAssociate application fleet
/#X-Amz-Target=PhotonAdminProxyService.AssociateApplicationFleetAssociates the specified application with the specified fleet. This is only supported for Elastic fleets. - POSTAssociate application to entitlement
/#X-Amz-Target=PhotonAdminProxyService.AssociateApplicationToEntitlementAssociates an application to entitle. - POSTAssociate fleet
/#X-Amz-Target=PhotonAdminProxyService.AssociateFleetAssociates the specified fleet with the specified stack. - POSTAssociate software to image builder
/#X-Amz-Target=PhotonAdminProxyService.AssociateSoftwareToImageBuilderAssociates license included application(s) with an existing image builder instance. - POSTBatch associate user stack
/#X-Amz-Target=PhotonAdminProxyService.BatchAssociateUserStackAssociates 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… - POSTBatch disassociate user stack
/#X-Amz-Target=PhotonAdminProxyService.BatchDisassociateUserStackDisassociates the specified users from the specified stacks. - POSTCopy image
/#X-Amz-Target=PhotonAdminProxyService.CopyImageCopies 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. - POSTCreate app block
/#X-Amz-Target=PhotonAdminProxyService.CreateAppBlockCreates an app block. App blocks are a WorkSpaces Applications resource that stores the details about the virtual hard disk in an S3 bucket. It also stores… - POSTCreate app block builder
/#X-Amz-Target=PhotonAdminProxyService.CreateAppBlockBuilderCreates an app block builder. - POSTCreate app block builder streaming uRL
/#X-Amz-Target=PhotonAdminProxyService.CreateAppBlockBuilderStreamingURLCreates a URL to start a create app block builder streaming session. - POSTCreate application
/#X-Amz-Target=PhotonAdminProxyService.CreateApplicationCreates an application. Applications are a WorkSpaces Applications resource that stores the details about how to launch applications on Elastic fleet… - POSTCreate directory config
/#X-Amz-Target=PhotonAdminProxyService.CreateDirectoryConfigCreates a Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to… - POSTCreate entitlement
/#X-Amz-Target=PhotonAdminProxyService.CreateEntitlementCreates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0… - POSTCreate export image task
/#X-Amz-Target=PhotonAdminProxyService.CreateExportImageTaskCreates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS… - POSTCreate fleet
/#X-Amz-Target=PhotonAdminProxyService.CreateFleetCreates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops. - POSTCreate image builder
/#X-Amz-Target=PhotonAdminProxyService.CreateImageBuilderCreates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING . When it is… - POSTCreate image builder streaming uRL
/#X-Amz-Target=PhotonAdminProxyService.CreateImageBuilderStreamingURLCreates a URL to start an image builder streaming session. - POSTCreate imported image
/#X-Amz-Target=PhotonAdminProxyService.CreateImportedImageCreates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications… - POSTCreate stack
/#X-Amz-Target=PhotonAdminProxyService.CreateStackCreates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. - POSTCreate streaming uRL
/#X-Amz-Target=PhotonAdminProxyService.CreateStreamingURLCreates a temporary URL to start an WorkSpaces Applications streaming session for the specified user. A streaming URL enables application streaming to be… - POSTCreate theme for stack
/#X-Amz-Target=PhotonAdminProxyService.CreateThemeForStackCreates custom branding that customizes the appearance of the streaming application catalog page. - POSTCreate updated image
/#X-Amz-Target=PhotonAdminProxyService.CreateUpdatedImageCreates a new image with the latest Windows operating system updates, driver updates, and WorkSpaces Applications agent software. For more information, see… - POSTCreate usage report subscription
/#X-Amz-Target=PhotonAdminProxyService.CreateUsageReportSubscriptionCreates a usage report subscription. Usage reports are generated daily. - POSTCreate user
/#X-Amz-Target=PhotonAdminProxyService.CreateUserCreates a new user in the user pool. - POSTDelete app block
/#X-Amz-Target=PhotonAdminProxyService.DeleteAppBlockDeletes an app block. - POSTDelete app block builder
/#X-Amz-Target=PhotonAdminProxyService.DeleteAppBlockBuilderDeletes an app block builder. An app block builder can only be deleted when it has no association with an app block. - POSTDelete application
/#X-Amz-Target=PhotonAdminProxyService.DeleteApplicationDeletes an application. - POSTDelete directory config
/#X-Amz-Target=PhotonAdminProxyService.DeleteDirectoryConfigDeletes the specified Directory Config object from WorkSpaces Applications. This object includes the information required to join streaming instances to an… - POSTDelete entitlement
/#X-Amz-Target=PhotonAdminProxyService.DeleteEntitlementDeletes the specified entitlement. - POSTDelete fleet
/#X-Amz-Target=PhotonAdminProxyService.DeleteFleetDeletes the specified fleet. - POSTDelete image
/#X-Amz-Target=PhotonAdminProxyService.DeleteImageDeletes 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. - POSTDelete image builder
/#X-Amz-Target=PhotonAdminProxyService.DeleteImageBuilderDeletes the specified image builder and releases the capacity. - POSTDelete image permissions
/#X-Amz-Target=PhotonAdminProxyService.DeleteImagePermissionsDeletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions… - POSTDelete stack
/#X-Amz-Target=PhotonAdminProxyService.DeleteStackDeletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also,… - POSTDelete theme for stack
/#X-Amz-Target=PhotonAdminProxyService.DeleteThemeForStackDeletes custom branding that customizes the appearance of the streaming application catalog page. - POSTDelete usage report subscription
/#X-Amz-Target=PhotonAdminProxyService.DeleteUsageReportSubscriptionDisables usage report generation. - POSTDelete user
/#X-Amz-Target=PhotonAdminProxyService.DeleteUserDeletes a user from the user pool. - POSTDescribe app block builder app block associations
/#X-Amz-Target=PhotonAdminProxyService.DescribeAppBlockBuilderAppBlockAssociationsRetrieves a list that describes one or more app block builder associations. - POSTDescribe app block builders
/#X-Amz-Target=PhotonAdminProxyService.DescribeAppBlockBuildersRetrieves a list that describes one or more app block builders. - POSTDescribe app blocks
/#X-Amz-Target=PhotonAdminProxyService.DescribeAppBlocksRetrieves a list that describes one or more app blocks. - POSTDescribe app license usage
/#X-Amz-Target=PhotonAdminProxyService.DescribeAppLicenseUsageRetrieves license included application usage information. - POSTDescribe application fleet associations
/#X-Amz-Target=PhotonAdminProxyService.DescribeApplicationFleetAssociationsRetrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified. - POSTDescribe applications
/#X-Amz-Target=PhotonAdminProxyService.DescribeApplicationsRetrieves a list that describes one or more applications. - POSTDescribe directory configs
/#X-Amz-Target=PhotonAdminProxyService.DescribeDirectoryConfigsRetrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, if the names for these objects are provided.… - POSTDescribe entitlements
/#X-Amz-Target=PhotonAdminProxyService.DescribeEntitlementsRetrieves a list that describes one of more entitlements. - POSTDescribe fleets
/#X-Amz-Target=PhotonAdminProxyService.DescribeFleetsRetrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described. - POSTDescribe image builders
/#X-Amz-Target=PhotonAdminProxyService.DescribeImageBuildersRetrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account… - POSTDescribe image permissions
/#X-Amz-Target=PhotonAdminProxyService.DescribeImagePermissionsRetrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. - POSTDescribe images
/#X-Amz-Target=PhotonAdminProxyService.DescribeImagesRetrieves 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. - POSTDescribe sessions
/#X-Amz-Target=PhotonAdminProxyService.DescribeSessionsRetrieves 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… - POSTDescribe software associations
/#X-Amz-Target=PhotonAdminProxyService.DescribeSoftwareAssociationsRetrieves license included application associations for a specified resource. - POSTDescribe stacks
/#X-Amz-Target=PhotonAdminProxyService.DescribeStacksRetrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described. - POSTDescribe theme for stack
/#X-Amz-Target=PhotonAdminProxyService.DescribeThemeForStackRetrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application… - POSTDescribe usage report subscriptions
/#X-Amz-Target=PhotonAdminProxyService.DescribeUsageReportSubscriptionsRetrieves a list that describes one or more usage report subscriptions. - POSTDescribe user stack associations
/#X-Amz-Target=PhotonAdminProxyService.DescribeUserStackAssociationsRetrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email… - POSTDescribe users
/#X-Amz-Target=PhotonAdminProxyService.DescribeUsersRetrieves a list that describes one or more specified users in the user pool. - POSTDisable user
/#X-Amz-Target=PhotonAdminProxyService.DisableUserDisables the specified user in the user pool. Users can't sign in to WorkSpaces Applications until they are re-enabled. This action does not delete the user. - POSTDisassociate app block builder app block
/#X-Amz-Target=PhotonAdminProxyService.DisassociateAppBlockBuilderAppBlockDisassociates a specified app block builder from a specified app block. - POSTDisassociate application fleet
/#X-Amz-Target=PhotonAdminProxyService.DisassociateApplicationFleetDisassociates the specified application from the fleet. - POSTDisassociate application from entitlement
/#X-Amz-Target=PhotonAdminProxyService.DisassociateApplicationFromEntitlementDeletes the specified application from the specified entitlement. - POSTDisassociate fleet
/#X-Amz-Target=PhotonAdminProxyService.DisassociateFleetDisassociates the specified fleet from the specified stack. - POSTDisassociate software from image builder
/#X-Amz-Target=PhotonAdminProxyService.DisassociateSoftwareFromImageBuilderRemoves license included application(s) association(s) from an image builder instance. - POSTDrain session instance
/#X-Amz-Target=PhotonAdminProxyService.DrainSessionInstanceDrains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once… - POSTEnable user
/#X-Amz-Target=PhotonAdminProxyService.EnableUserEnables a user in the user pool. After being enabled, users can sign in to WorkSpaces Applications and open applications from the stacks to which they are… - POSTExpire session
/#X-Amz-Target=PhotonAdminProxyService.ExpireSessionImmediately stops the specified streaming session. - POSTGet export image task
/#X-Amz-Target=PhotonAdminProxyService.GetExportImageTaskRetrieves information about an export image task, including its current state, progress, and any error details. - POSTList associated fleets
/#X-Amz-Target=PhotonAdminProxyService.ListAssociatedFleetsRetrieves the name of the fleet that is associated with the specified stack. - POSTList associated stacks
/#X-Amz-Target=PhotonAdminProxyService.ListAssociatedStacksRetrieves the name of the stack with which the specified fleet is associated. - POSTList entitled applications
/#X-Amz-Target=PhotonAdminProxyService.ListEntitledApplicationsRetrieves a list of entitled applications. - POSTList export image tasks
/#X-Amz-Target=PhotonAdminProxyService.ListExportImageTasksLists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations. - POSTList tags for resource
/#X-Amz-Target=PhotonAdminProxyService.ListTagsForResourceRetrieves a list of all tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and… - POSTStart app block builder
/#X-Amz-Target=PhotonAdminProxyService.StartAppBlockBuilderStarts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new… - POSTStart fleet
/#X-Amz-Target=PhotonAdminProxyService.StartFleetStarts the specified fleet. - POSTStart image builder
/#X-Amz-Target=PhotonAdminProxyService.StartImageBuilderStarts the specified image builder. - POSTStart software deployment to image builder
/#X-Amz-Target=PhotonAdminProxyService.StartSoftwareDeploymentToImageBuilderInitiates license included applications deployment to an image builder instance. - POSTStop app block builder
/#X-Amz-Target=PhotonAdminProxyService.StopAppBlockBuilderStops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted. - POSTStop fleet
/#X-Amz-Target=PhotonAdminProxyService.StopFleetStops the specified fleet. - POSTStop image builder
/#X-Amz-Target=PhotonAdminProxyService.StopImageBuilderStops the specified image builder. - POSTTag resource
/#X-Amz-Target=PhotonAdminProxyService.TagResourceAdds or overwrites one or more tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets,… - POSTUntag resource
/#X-Amz-Target=PhotonAdminProxyService.UntagResourceDisassociates one or more specified tags from the specified WorkSpaces Applications resource. To list the current tags for your resources, use… - POSTUpdate app block builder
/#X-Amz-Target=PhotonAdminProxyService.UpdateAppBlockBuilderUpdates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING… - POSTUpdate application
/#X-Amz-Target=PhotonAdminProxyService.UpdateApplicationUpdates the specified application. - POSTUpdate directory config
/#X-Amz-Target=PhotonAdminProxyService.UpdateDirectoryConfigUpdates the specified Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image… - POSTUpdate entitlement
/#X-Amz-Target=PhotonAdminProxyService.UpdateEntitlementUpdates the specified entitlement. - POSTUpdate fleet
/#X-Amz-Target=PhotonAdminProxyService.UpdateFleetUpdates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state,… - POSTUpdate image builder
/#X-Amz-Target=PhotonAdminProxyService.UpdateImageBuilderUpdates the specified fields for the specified image builder. The image builder must be in the STOPPED state. - POSTUpdate image permissions
/#X-Amz-Target=PhotonAdminProxyService.UpdateImagePermissionsAdds or updates permissions for the specified private image. - POSTUpdate stack
/#X-Amz-Target=PhotonAdminProxyService.UpdateStackUpdates the specified fields for the specified stack. - POSTUpdate theme for stack
/#X-Amz-Target=PhotonAdminProxyService.UpdateThemeForStackUpdates custom branding that customizes the appearance of the streaming application catalog page.
API details
- Base URL
https://appstream2.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 90 operations on 90 pathsPOST 90
- Description format
- AWS Smithy model, API version
2016-12-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon AppStream in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon AppStream collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate app block builder app block” (POST /#X-Amz-Target=PhotonAdminProxyService.AssociateAppBlockBuilderAppBlock), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon AppStream?
Amazon WorkSpaces Applications This is the Amazon WorkSpaces Applications API Reference . This documentation provides descriptions and syntax for each of the… It is listed under Developer tools and has 90 endpoints.
Who publishes the Amazon AppStream?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon AppStream?
Requests go to https://appstream2.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon AppStream?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon AppStream have?
90 operations on 90 paths (90 POST).
Is forking the Amazon AppStream free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.