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

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 Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

To learn more about AppStream 2.0, see the following resources:

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)

Associates the specified fleet with the specified stack.

Public Method BatchAssociateUserStack(BatchAssociateUserStackRequest)

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

Public Method BatchAssociateUserStackAsync(BatchAssociateUserStackRequest, CancellationToken)

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

Public Method BatchDisassociateUserStack(BatchDisassociateUserStackRequest)

Disassociates the specified users from the specified stacks.

Public Method BatchDisassociateUserStackAsync(BatchDisassociateUserStackRequest, CancellationToken)

Disassociates the specified users from the specified stacks.

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)

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 CreateDirectoryConfig(CreateDirectoryConfigRequest)

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

Public Method CreateDirectoryConfigAsync(CreateDirectoryConfigRequest, CancellationToken)

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

Public Method CreateFleet(CreateFleetRequest)

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

Public Method CreateFleetAsync(CreateFleetRequest, CancellationToken)

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

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)

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 CreateImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest)

Creates a URL to start an image builder streaming session.

Public Method CreateImageBuilderStreamingURLAsync(CreateImageBuilderStreamingURLRequest, CancellationToken)

Creates a URL to start an image builder streaming session.

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)

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

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)

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 CreateUsageReportSubscription(CreateUsageReportSubscriptionRequest)

Creates a usage report subscription. Usage reports are generated daily.

Public Method CreateUsageReportSubscriptionAsync(CreateUsageReportSubscriptionRequest, CancellationToken)

Creates a usage report subscription. Usage reports are generated daily.

Public Method CreateUser(CreateUserRequest)

Creates a new user in the user pool.

Public Method CreateUserAsync(CreateUserRequest, CancellationToken)

Creates a new user in the user pool.

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)

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 DeleteFleet(DeleteFleetRequest)

Deletes the specified fleet.

Public Method DeleteFleetAsync(DeleteFleetRequest, CancellationToken)

Deletes the specified fleet.

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)

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 DeleteImageBuilder(DeleteImageBuilderRequest)

Deletes the specified image builder and releases the capacity.

Public Method DeleteImageBuilderAsync(DeleteImageBuilderRequest, CancellationToken)

Deletes the specified image builder and releases the capacity.

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)

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 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)

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 DeleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest)

Disables usage report generation.

Public Method DeleteUsageReportSubscriptionAsync(DeleteUsageReportSubscriptionRequest, CancellationToken)

Disables usage report generation.

Public Method DeleteUser(DeleteUserRequest)

Deletes a user from the user pool.

Public Method DeleteUserAsync(DeleteUserRequest, CancellationToken)

Deletes a user from the user pool.

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

Public Method DescribeDirectoryConfigsAsync(DescribeDirectoryConfigsRequest, CancellationToken)

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

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)

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 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)

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 DescribeImagePermissions(DescribeImagePermissionsRequest)

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Public Method DescribeImagePermissionsAsync(DescribeImagePermissionsRequest, CancellationToken)

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

Public Method DescribeImages(DescribeImagesRequest)

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.

Public Method DescribeImagesAsync(DescribeImagesRequest, CancellationToken)

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.

Public Method DescribeSessions(DescribeSessionsRequest)

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 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)

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 for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

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)

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 DescribeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest)

Retrieves a list that describes one or more usage report subscriptions.

Public Method DescribeUsageReportSubscriptionsAsync(DescribeUsageReportSubscriptionsRequest, CancellationToken)

Retrieves a list that describes one or more usage report subscriptions.

Public Method DescribeUsers(DescribeUsersRequest)

Retrieves a list that describes one or more specified users in the user pool.

Public Method DescribeUsersAsync(DescribeUsersRequest, CancellationToken)

Retrieves a list that describes one or more specified users in the user pool.

Public Method DescribeUserStackAssociations(DescribeUserStackAssociationsRequest)

Retrieves 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

Public Method DescribeUserStackAssociationsAsync(DescribeUserStackAssociationsRequest, CancellationToken)

Retrieves 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

Public Method DisableUser(DisableUserRequest)

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.

Public Method DisableUserAsync(DisableUserRequest, CancellationToken)

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.

Public Method DisassociateFleet(DisassociateFleetRequest)

Disassociates the specified fleet from the specified stack.

Public Method DisassociateFleetAsync(DisassociateFleetRequest, CancellationToken)

Disassociates the specified fleet from the specified stack.

Public Method EnableUser(EnableUserRequest)

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.

Public Method EnableUserAsync(EnableUserRequest, CancellationToken)

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.

Public Method ExpireSession(ExpireSessionRequest)

Immediately stops the specified streaming session.

Public Method ExpireSessionAsync(ExpireSessionRequest, CancellationToken)

Immediately stops the specified streaming session.

Public Method ListAssociatedFleets(ListAssociatedFleetsRequest)

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

Public Method ListAssociatedFleetsAsync(ListAssociatedFleetsRequest, CancellationToken)

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

Public Method ListAssociatedStacks(ListAssociatedStacksRequest)

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

Public Method ListAssociatedStacksAsync(ListAssociatedStacksRequest, CancellationToken)

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

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 Administration Guide.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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 Administration Guide.

Public Method StartFleet(StartFleetRequest)

Starts the specified fleet.

Public Method StartFleetAsync(StartFleetRequest, CancellationToken)

Starts the specified fleet.

Public Method StartImageBuilder(StartImageBuilderRequest)

Starts the specified image builder.

Public Method StartImageBuilderAsync(StartImageBuilderRequest, CancellationToken)

Starts the specified image builder.

Public Method StopFleet(StopFleetRequest)

Stops the specified fleet.

Public Method StopFleetAsync(StopFleetRequest, CancellationToken)

Stops the specified fleet.

Public Method StopImageBuilder(StopImageBuilderRequest)

Stops the specified image builder.

Public Method StopImageBuilderAsync(StopImageBuilderRequest, CancellationToken)

Stops the specified image builder.

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 Administration Guide.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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 Administration Guide.

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 Administration Guide.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

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 Administration Guide.

Public Method UpdateDirectoryConfig(UpdateDirectoryConfigRequest)

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

Public Method UpdateDirectoryConfigAsync(UpdateDirectoryConfigRequest, CancellationToken)

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

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

Public Method UpdateFleetAsync(UpdateFleetRequest, CancellationToken)

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

Public Method UpdateImagePermissions(UpdateImagePermissionsRequest)

Adds or updates permissions for the specified private image.

Public Method UpdateImagePermissionsAsync(UpdateImagePermissionsRequest, CancellationToken)

Adds or updates permissions for the specified private image.

Public Method UpdateStack(UpdateStackRequest)

Updates the specified fields for the specified stack.

Public Method UpdateStackAsync(UpdateStackRequest, CancellationToken)

Updates the specified fields for the specified stack.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

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

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