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.

Implementation 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

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AppStream.AmazonAppStreamClient

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

Syntax

C#
public class AmazonAppStreamClient : AmazonServiceClient
         IAmazonAppStream, IAmazonService, IDisposable

The AmazonAppStreamClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAppStreamClient()

Constructs AmazonAppStreamClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppStreamClient(RegionEndpoint)

Constructs AmazonAppStreamClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppStreamClient(AmazonAppStreamConfig)

Constructs AmazonAppStreamClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppStreamClient(AWSCredentials)

Constructs AmazonAppStreamClient with AWS Credentials

Public Method AmazonAppStreamClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAppStreamClient with AWS Credentials

Public Method AmazonAppStreamClient(AWSCredentials, AmazonAppStreamConfig)

Constructs AmazonAppStreamClient with AWS Credentials and an AmazonAppStreamClient Configuration object.

Public Method AmazonAppStreamClient(string, string)

Constructs AmazonAppStreamClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppStreamClient(string, string, RegionEndpoint)

Constructs AmazonAppStreamClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppStreamClient(string, string, AmazonAppStreamConfig)

Constructs AmazonAppStreamClient with AWS Access Key ID, AWS Secret Key and an AmazonAppStreamClient Configuration object.

Public Method AmazonAppStreamClient(string, string, string)

Constructs AmazonAppStreamClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppStreamClient(string, string, string, RegionEndpoint)

Constructs AmazonAppStreamClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppStreamClient(string, string, string, AmazonAppStreamConfig)

Constructs AmazonAppStreamClient with AWS Access Key ID, AWS Secret Key and an AmazonAppStreamClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

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

Creates a directory configuration.

Public Method CreateDirectoryConfigAsync(CreateDirectoryConfigRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDirectoryConfig operation.

Public Method CreateFleet(CreateFleetRequest)

Creates a fleet.

Public Method CreateFleetAsync(CreateFleetRequest, CancellationToken)

Initiates the asynchronous execution of the CreateFleet operation.

Public Method CreateImageBuilder(CreateImageBuilderRequest)

Public Method CreateImageBuilderAsync(CreateImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the CreateImageBuilder operation.

Public Method CreateImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest)

Public Method CreateImageBuilderStreamingURLAsync(CreateImageBuilderStreamingURLRequest, CancellationToken)

Initiates the asynchronous execution of the CreateImageBuilderStreamingURL operation.

Public Method CreateStack(CreateStackRequest)

Creates a stack.

Public Method CreateStackAsync(CreateStackRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStack operation.

Public Method CreateStreamingURL(CreateStreamingURLRequest)

Creates a URL to start a streaming session for the specified user.

By default, the URL is valid only for one minute from the time that it is generated.

Public Method CreateStreamingURLAsync(CreateStreamingURLRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStreamingURL operation.

Public Method DeleteDirectoryConfig(DeleteDirectoryConfigRequest)

Deletes the specified directory configuration.

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)

Public Method DeleteImageAsync(DeleteImageRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteImage operation.

Public Method DeleteImageBuilder(DeleteImageBuilderRequest)

Public Method DeleteImageBuilderAsync(DeleteImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteImageBuilder operation.

Public Method DeleteStack(DeleteStackRequest)

Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are released.

Public Method DeleteStackAsync(DeleteStackRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStack operation.

Public Method DescribeDirectoryConfigs(DescribeDirectoryConfigsRequest)

Describes the specified directory configurations.

Public Method DescribeDirectoryConfigsAsync(DescribeDirectoryConfigsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDirectoryConfigs operation.

Public Method DescribeFleets(DescribeFleetsRequest)

Describes the specified fleets or all fleets in the account.

Public Method DescribeFleetsAsync(DescribeFleetsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeFleets operation.

Public Method DescribeImageBuilders(DescribeImageBuildersRequest)

Public Method DescribeImageBuildersAsync(DescribeImageBuildersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeImageBuilders operation.

Public Method DescribeImages(DescribeImagesRequest)

Describes the specified images or all images in the account.

Public Method DescribeImagesAsync(DescribeImagesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeImages operation.

Public Method DescribeSessions(DescribeSessionsRequest)

Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. 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)

Describes the specified stacks or all stacks in the account.

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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ExpireSession(ExpireSessionRequest)

Stops the specified streaming session.

Public Method ExpireSessionAsync(ExpireSessionRequest, CancellationToken)

Initiates the asynchronous execution of the ExpireSession operation.

Public Method ListAssociatedFleets(ListAssociatedFleetsRequest)

Lists the fleets associated with the specified stack.

Public Method ListAssociatedFleetsAsync(ListAssociatedFleetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAssociatedFleets operation.

Public Method ListAssociatedStacks(ListAssociatedStacksRequest)

Lists the stacks associated with the specified fleet.

Public Method ListAssociatedStacksAsync(ListAssociatedStacksRequest, CancellationToken)

Initiates the asynchronous execution of the ListAssociatedStacks 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)

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)

Public Method StopImageBuilderAsync(StopImageBuilderRequest, CancellationToken)

Initiates the asynchronous execution of the StopImageBuilder operation.

Public Method UpdateDirectoryConfig(UpdateDirectoryConfigRequest)

Updates the specified directory configuration.

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 UpdateStack(UpdateStackRequest)

Updates the specified stack.

Public Method UpdateStackAsync(UpdateStackRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStack operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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