amazonaws.com – appstream
Amazon AppStream 2.0
This is the Amazon AppStream 2.0 API Reference. 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.
You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see in the Amazon AppStream 2.0 Administration Guide.
To learn more about AppStream 2.0, see the following resources:
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:appstream/2016-12-01.json
- Provider
- amazonaws.com:appstream / appstream
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/appstream/2016-12-01/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/appstream/2016-12-01/openapi.yaml
Tools (67)
Extracted live via the executor SDK.
-
xAmzTargetPhotonAdminProxyServiceAssociateApplicationFleet.associateApplicationFleetAssociates the specified application with the specified fleet. This is only supported for Elastic fleets.
-
xAmzTargetPhotonAdminProxyServiceAssociateApplicationToEntitlement.associateApplicationToEntitlementAssociates an application to entitle.
-
xAmzTargetPhotonAdminProxyServiceAssociateFleet.associateFleetAssociates the specified fleet with the specified stack.
-
xAmzTargetPhotonAdminProxyServiceBatchAssociateUserStack.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 domain.
-
xAmzTargetPhotonAdminProxyServiceBatchDisassociateUserStack.batchDisassociateUserStackDisassociates the specified users from the specified stacks.
-
xAmzTargetPhotonAdminProxyServiceCopyImage.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.
-
xAmzTargetPhotonAdminProxyServiceCreateAppBlock.createAppBlockCreates an app block.
App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.
This is only supported for Elastic fleets.
-
xAmzTargetPhotonAdminProxyServiceCreateApplication.createApplicationCreates an application.
Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.
This is only supported for Elastic fleets.
-
xAmzTargetPhotonAdminProxyServiceCreateDirectoryConfig.createDirectoryConfigCreates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
-
xAmzTargetPhotonAdminProxyServiceCreateEntitlement.createEntitlementCreates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
-
xAmzTargetPhotonAdminProxyServiceCreateFleet.createFleetCreates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
-
xAmzTargetPhotonAdminProxyServiceCreateImageBuilder.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 ready, the state isRUNNING. -
xAmzTargetPhotonAdminProxyServiceCreateImageBuilderStreamingUrl.createImageBuilderStreamingUrlCreates a URL to start an image builder streaming session.
-
xAmzTargetPhotonAdminProxyServiceCreateStack.createStackCreates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
-
xAmzTargetPhotonAdminProxyServiceCreateStreamingUrl.createStreamingUrlCreates 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 user setup.
-
xAmzTargetPhotonAdminProxyServiceCreateUpdatedImage.createUpdatedImageCreates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in , in the Amazon AppStream 2.0 Administration Guide.
-
xAmzTargetPhotonAdminProxyServiceCreateUsageReportSubscription.createUsageReportSubscriptionCreates a usage report subscription. Usage reports are generated daily.
-
xAmzTargetPhotonAdminProxyServiceCreateUser.createUserCreates a new user in the user pool.
-
xAmzTargetPhotonAdminProxyServiceDeleteAppBlock.deleteAppBlockDeletes an app block.
-
xAmzTargetPhotonAdminProxyServiceDeleteApplication.deleteApplicationDeletes an application.
-
xAmzTargetPhotonAdminProxyServiceDeleteDirectoryConfig.deleteDirectoryConfigDeletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
-
xAmzTargetPhotonAdminProxyServiceDeleteEntitlement.deleteEntitlementDeletes the specified entitlement.
-
xAmzTargetPhotonAdminProxyServiceDeleteFleet.deleteFleetDeletes the specified fleet.
-
xAmzTargetPhotonAdminProxyServiceDeleteImage.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.
-
xAmzTargetPhotonAdminProxyServiceDeleteImageBuilder.deleteImageBuilderDeletes the specified image builder and releases the capacity.
-
xAmzTargetPhotonAdminProxyServiceDeleteImagePermissions.deleteImagePermissionsDeletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
-
xAmzTargetPhotonAdminProxyServiceDeleteStack.deleteStackDeletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
-
xAmzTargetPhotonAdminProxyServiceDeleteUsageReportSubscription.deleteUsageReportSubscriptionDisables usage report generation.
-
xAmzTargetPhotonAdminProxyServiceDeleteUser.deleteUserDeletes a user from the user pool.
-
xAmzTargetPhotonAdminProxyServiceDescribeAppBlocks.describeAppBlocksRetrieves a list that describes one or more app blocks.
-
xAmzTargetPhotonAdminProxyServiceDescribeApplicationFleetAssociations.describeApplicationFleetAssociationsRetrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
-
xAmzTargetPhotonAdminProxyServiceDescribeApplications.describeApplicationsRetrieves a list that describes one or more applications.
-
xAmzTargetPhotonAdminProxyServiceDescribeDirectoryConfigs.describeDirectoryConfigsRetrieves 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 Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
-
xAmzTargetPhotonAdminProxyServiceDescribeEntitlements.describeEntitlementsRetrieves a list that describes one of more entitlements.
-
xAmzTargetPhotonAdminProxyServiceDescribeFleets.describeFleetsRetrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
-
xAmzTargetPhotonAdminProxyServiceDescribeImageBuilders.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 are described.
-
xAmzTargetPhotonAdminProxyServiceDescribeImagePermissions.describeImagePermissionsRetrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
-
xAmzTargetPhotonAdminProxyServiceDescribeImages.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.
-
xAmzTargetPhotonAdminProxyServiceDescribeSessions.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 sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
-
xAmzTargetPhotonAdminProxyServiceDescribeStacks.describeStacksRetrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
-
xAmzTargetPhotonAdminProxyServiceDescribeUsageReportSubscriptions.describeUsageReportSubscriptionsRetrieves a list that describes one or more usage report subscriptions.
-
xAmzTargetPhotonAdminProxyServiceDescribeUsers.describeUsersRetrieves a list that describes one or more specified users in the user pool.
-
xAmzTargetPhotonAdminProxyServiceDescribeUserStackAssociations.describeUserStackAssociationsRetrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
-
The stack name
-
The user name (email address of the user associated with the stack) and the authentication type for the user
-
-
xAmzTargetPhotonAdminProxyServiceDisableUser.disableUserDisables 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.
-
xAmzTargetPhotonAdminProxyServiceDisassociateApplicationFleet.disassociateApplicationFleetDisassociates the specified application from the fleet.
-
xAmzTargetPhotonAdminProxyServiceDisassociateApplicationFromEntitlement.disassociateApplicationFromEntitlementDeletes the specified application from the specified entitlement.
-
xAmzTargetPhotonAdminProxyServiceDisassociateFleet.disassociateFleetDisassociates the specified fleet from the specified stack.
-
xAmzTargetPhotonAdminProxyServiceEnableUser.enableUserEnables 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.
-
xAmzTargetPhotonAdminProxyServiceExpireSession.expireSessionImmediately stops the specified streaming session.
-
xAmzTargetPhotonAdminProxyServiceListAssociatedFleets.listAssociatedFleetsRetrieves the name of the fleet that is associated with the specified stack.
-
xAmzTargetPhotonAdminProxyServiceListAssociatedStacks.listAssociatedStacksRetrieves the name of the stack with which the specified fleet is associated.
-
xAmzTargetPhotonAdminProxyServiceListEntitledApplications.listEntitledApplicationsRetrieves a list of entitled applications.
-
xAmzTargetPhotonAdminProxyServiceListTagsForResource.listTagsForResourceRetrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
For more information about tags, see in the Amazon AppStream 2.0 Administration Guide.
-
xAmzTargetPhotonAdminProxyServiceStartFleet.startFleetStarts the specified fleet.
-
xAmzTargetPhotonAdminProxyServiceStartImageBuilder.startImageBuilderStarts the specified image builder.
-
xAmzTargetPhotonAdminProxyServiceStopFleet.stopFleetStops the specified fleet.
-
xAmzTargetPhotonAdminProxyServiceStopImageBuilder.stopImageBuilderStops the specified image builder.
-
xAmzTargetPhotonAdminProxyServiceTagResource.tagResourceAdds 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.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.
To list the current tags for your resources, use ListTagsForResource [blocked]. To disassociate tags from your resources, use UntagResource [blocked].
For more information about tags, see in the Amazon AppStream 2.0 Administration Guide.
-
xAmzTargetPhotonAdminProxyServiceUntagResource.untagResourceDisassociates one or more specified tags from the specified AppStream 2.0 resource.
To list the current tags for your resources, use ListTagsForResource [blocked].
For more information about tags, see in the Amazon AppStream 2.0 Administration Guide.
-
xAmzTargetPhotonAdminProxyServiceUpdateApplication.updateApplicationUpdates the specified application.
-
xAmzTargetPhotonAdminProxyServiceUpdateDirectoryConfig.updateDirectoryConfigUpdates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
-
xAmzTargetPhotonAdminProxyServiceUpdateEntitlement.updateEntitlementUpdates the specified entitlement.
-
xAmzTargetPhotonAdminProxyServiceUpdateFleet.updateFleetUpdates the specified fleet.
If the fleet is in the
STOPPEDstate, you can update any attribute except the fleet name.If the fleet is in the
RUNNINGstate, you can update the following based on the fleet type:-
Always-On and On-Demand fleet types
You can update the
DisplayName,ComputeCapacity,ImageARN,ImageName,IdleDisconnectTimeoutInSeconds, andDisconnectTimeoutInSecondsattributes. -
Elastic fleet type
You can update the
DisplayName,IdleDisconnectTimeoutInSeconds,DisconnectTimeoutInSeconds,MaxConcurrentSessions,SessionScriptS3LocationandUsbDeviceFilterStringsattributes.
If the fleet is in the
STARTINGorSTOPPEDstate, you can't update it. -
-
xAmzTargetPhotonAdminProxyServiceUpdateImagePermissions.updateImagePermissionsAdds or updates permissions for the specified private image.
-
xAmzTargetPhotonAdminProxyServiceUpdateStack.updateStackUpdates the specified fields for the specified stack.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools