AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing AppStream Amazon AppStream 2.0

You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.

Inheritance Hierarchy

Amazon.AppStream.IAmazonAppStream

Namespace: Amazon.AppStream
Assembly: AWSSDK.AppStream.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonAppStream
         IAmazonService, IDisposable

The IAmazonAppStream type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateFleet(AssociateFleetRequest)

Associates the specified fleet with the specified stack.

Public Method AssociateFleetAsync(AssociateFleetRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateFleet operation.

Public Method CopyImage(CopyImageRequest)

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.

Public Method CopyImageAsync(CopyImageRequest, CancellationToken)

Initiates the asynchronous execution of the CopyImage operation.

Public Method CreateDirectoryConfig(CreateDirectoryConfigRequest)

Creates a Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

Public Method CreateDirectoryConfigAsync(CreateDirectoryConfigRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDirectoryConfig operation.

Public Method CreateFleet(CreateFleetRequest)

Creates a fleet. A fleet consists of streaming instances that run a specified image.

Public Method CreateFleetAsync(CreateFleetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateFleet operation.

Public Method CreateImageBuilder(CreateImageBuilderRequest)

Creates 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 is RUNNING.

Public Method CreateImageBuilderAsync(CreateImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the CreateImageBuilder operation.

Public Method CreateImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest)

Creates a URL to start an image builder streaming session.

Public Method CreateImageBuilderStreamingURLAsync(CreateImageBuilderStreamingURLRequest, CancellationToken)

Initiates the asynchronous execution of the CreateImageBuilderStreamingURL operation.

Public Method CreateStack(CreateStackRequest)

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Public Method CreateStackAsync(CreateStackRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStack operation.

Public Method CreateStreamingURL(CreateStreamingURLRequest)

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 user setup.

Public Method CreateStreamingURLAsync(CreateStreamingURLRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStreamingURL operation.

Public Method DeleteDirectoryConfig(DeleteDirectoryConfigRequest)

Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

Public Method DeleteDirectoryConfigAsync(DeleteDirectoryConfigRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDirectoryConfig operation.

Public Method DeleteFleet(DeleteFleetRequest)

Deletes the specified fleet.

Public Method DeleteFleetAsync(DeleteFleetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteFleet operation.

Public Method DeleteImage(DeleteImageRequest)

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.

Public Method DeleteImageAsync(DeleteImageRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteImage operation.

Public Method DeleteImageBuilder(DeleteImageBuilderRequest)

Deletes the specified image builder and releases the capacity.

Public Method DeleteImageBuilderAsync(DeleteImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteImageBuilder operation.

Public Method DeleteImagePermissions(DeleteImagePermissionsRequest)

Deletes 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.

Public Method DeleteImagePermissionsAsync(DeleteImagePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteImagePermissions operation.

Public Method DeleteStack(DeleteStackRequest)

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 reservations made for application streaming sessions for the stack are released.

Public Method DeleteStackAsync(DeleteStackRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStack operation.

Public Method DescribeDirectoryConfigs(DescribeDirectoryConfigsRequest)

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 Directory Config objects in the account are described. These objects include the information required to join streaming instances to an Active Directory domain.

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

Public Method DescribeDirectoryConfigsAsync(DescribeDirectoryConfigsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDirectoryConfigs operation.

Public Method DescribeFleets(DescribeFleetsRequest)

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Public Method DescribeFleetsAsync(DescribeFleetsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeFleets operation.

Public Method DescribeImageBuilders(DescribeImageBuildersRequest)

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 described.

Public Method DescribeImageBuildersAsync(DescribeImageBuildersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeImageBuilders operation.

Public Method DescribeImagePermissions(DescribeImagePermissionsRequest)

Retrieves a list that describes the permissions for a private image that you own.

Public Method DescribeImagePermissionsAsync(DescribeImagePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeImagePermissions operation.

Public Method DescribeImages(DescribeImagesRequest)

Retrieves a list that describes one or more specified images, if the image names are provided. Otherwise, all images in the account are described.

Public Method DescribeImagesAsync(DescribeImagesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeImages operation.

Public Method DescribeSessions(DescribeSessionsRequest)

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a user ID 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.

Public Method DescribeSessionsAsync(DescribeSessionsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeSessions operation.

Public Method DescribeStacks(DescribeStacksRequest)

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Public Method DescribeStacksAsync(DescribeStacksRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStacks operation.

Public Method DisassociateFleet(DisassociateFleetRequest)

Disassociates the specified fleet from the specified stack.

Public Method DisassociateFleetAsync(DisassociateFleetRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateFleet operation.

Public Method ExpireSession(ExpireSessionRequest)

Immediately stops the specified streaming session.

Public Method ExpireSessionAsync(ExpireSessionRequest, CancellationToken)

Initiates the asynchronous execution of the ExpireSession operation.

Public Method ListAssociatedFleets(ListAssociatedFleetsRequest)

Retrieves the name of the fleet that is associated with the specified stack.

Public Method ListAssociatedFleetsAsync(ListAssociatedFleetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAssociatedFleets operation.

Public Method ListAssociatedStacks(ListAssociatedStacksRequest)

Retrieves the name of the stack with which the specified fleet is associated.

Public Method ListAssociatedStacksAsync(ListAssociatedStacksRequest, CancellationToken)

Initiates the asynchronous execution of the ListAssociatedStacks operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

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.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method StartFleet(StartFleetRequest)

Starts the specified fleet.

Public Method StartFleetAsync(StartFleetRequest, CancellationToken)

Initiates the asynchronous execution of the StartFleet operation.

Public Method StartImageBuilder(StartImageBuilderRequest)

Starts the specified image builder.

Public Method StartImageBuilderAsync(StartImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the StartImageBuilder operation.

Public Method StopFleet(StopFleetRequest)

Stops the specified fleet.

Public Method StopFleetAsync(StopFleetRequest, CancellationToken)

Initiates the asynchronous execution of the StopFleet operation.

Public Method StopImageBuilder(StopImageBuilderRequest)

Stops the specified image builder.

Public Method StopImageBuilderAsync(StopImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the StopImageBuilder operation.

Public Method TagResource(TagResourceRequest)

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.

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. To disassociate tags from your resources, use UntagResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

Public Method UntagResource(UntagResourceRequest)

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Developer Guide.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

Public Method UpdateDirectoryConfig(UpdateDirectoryConfigRequest)

Updates the specified Directory Config object in AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

Public Method UpdateDirectoryConfigAsync(UpdateDirectoryConfigRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDirectoryConfig operation.

Public Method UpdateFleet(UpdateFleetRequest)

Updates 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, you can update the DisplayName and ComputeCapacity attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

Public Method UpdateFleetAsync(UpdateFleetRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateFleet operation.

Public Method UpdateImagePermissions(UpdateImagePermissionsRequest)

Adds or updates permissions for the specified private image.

Public Method UpdateImagePermissionsAsync(UpdateImagePermissionsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateImagePermissions operation.

Public Method UpdateStack(UpdateStackRequest)

Updates the specified fields for the specified stack.

Public Method UpdateStackAsync(UpdateStackRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStack operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms