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.

Classes

NameDescription
Class Application

Describes an application in the application catalog.

Class AssociateFleetRequest

Container for the parameters to the AssociateFleet operation. Associates the specified fleet with the specified stack.

Class AssociateFleetResponse

This is the response object from the AssociateFleet operation.

Class ComputeCapacity

Describes the capacity for a fleet.

Class ComputeCapacityStatus

Describes the capacity status for a fleet.

Class ConcurrentModificationException

AppStream exception

Class CopyImageRequest

Container for the parameters to the CopyImage operation. 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.

Class CopyImageResponse

This is the response object from the CopyImage operation.

Class CreateDirectoryConfigRequest

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

Class CreateDirectoryConfigResponse

This is the response object from the CreateDirectoryConfig operation.

Class CreateFleetRequest

Container for the parameters to the CreateFleet operation. Creates a fleet. A fleet consists of streaming instances that run a specified image.

Class CreateFleetResponse

This is the response object from the CreateFleet operation.

Class CreateImageBuilderRequest

Container for the parameters to the CreateImageBuilder operation. 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.

Class CreateImageBuilderResponse

This is the response object from the CreateImageBuilder operation.

Class CreateImageBuilderStreamingURLRequest

Container for the parameters to the CreateImageBuilderStreamingURL operation. Creates a URL to start an image builder streaming session.

Class CreateImageBuilderStreamingURLResponse

This is the response object from the CreateImageBuilderStreamingURL operation.

Class CreateStackRequest

Container for the parameters to the CreateStack operation. Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

Class CreateStackResponse

This is the response object from the CreateStack operation.

Class CreateStreamingURLRequest

Container for the parameters to the CreateStreamingURL operation. 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.

Class CreateStreamingURLResponse

This is the response object from the CreateStreamingURL operation.

Class DeleteDirectoryConfigRequest

Container for the parameters to the DeleteDirectoryConfig operation. 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.

Class DeleteDirectoryConfigResponse

This is the response object from the DeleteDirectoryConfig operation.

Class DeleteFleetRequest

Container for the parameters to the DeleteFleet operation. Deletes the specified fleet.

Class DeleteFleetResponse

This is the response object from the DeleteFleet operation.

Class DeleteImageBuilderRequest

Container for the parameters to the DeleteImageBuilder operation. Deletes the specified image builder and releases the capacity.

Class DeleteImageBuilderResponse

This is the response object from the DeleteImageBuilder operation.

Class DeleteImagePermissionsRequest

Container for the parameters to the DeleteImagePermissions operation. 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.

Class DeleteImagePermissionsResponse

This is the response object from the DeleteImagePermissions operation.

Class DeleteImageRequest

Container for the parameters to the DeleteImage operation. 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.

Class DeleteImageResponse

This is the response object from the DeleteImage operation.

Class DeleteStackRequest

Container for the parameters to the DeleteStack operation. 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.

Class DeleteStackResponse

This is the response object from the DeleteStack operation.

Class DescribeDirectoryConfigsRequest

Container for the parameters to the DescribeDirectoryConfigs operation. 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.

Class DescribeDirectoryConfigsResponse

This is the response object from the DescribeDirectoryConfigs operation.

Class DescribeFleetsRequest

Container for the parameters to the DescribeFleets operation. Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Class DescribeFleetsResponse

This is the response object from the DescribeFleets operation.

Class DescribeImageBuildersRequest

Container for the parameters to the DescribeImageBuilders operation. 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.

Class DescribeImageBuildersResponse

This is the response object from the DescribeImageBuilders operation.

Class DescribeImagePermissionsRequest

Container for the parameters to the DescribeImagePermissions operation. Retrieves a list that describes the permissions for a private image that you own.

Class DescribeImagePermissionsResponse

This is the response object from the DescribeImagePermissions operation.

Class DescribeImagesRequest

Container for the parameters to the DescribeImages operation. Retrieves a list that describes one or more specified images, if the image names are provided. Otherwise, all images in the account are described.

Class DescribeImagesResponse

This is the response object from the DescribeImages operation.

Class DescribeSessionsRequest

Container for the parameters to the DescribeSessions operation. 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.

Class DescribeSessionsResponse

This is the response object from the DescribeSessions operation.

Class DescribeStacksRequest

Container for the parameters to the DescribeStacks operation. Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Class DescribeStacksResponse

This is the response object from the DescribeStacks operation.

Class DirectoryConfig

Configuration information for the directory used to join domains.

Class DisassociateFleetRequest

Container for the parameters to the DisassociateFleet operation. Disassociates the specified fleet from the specified stack.

Class DisassociateFleetResponse

This is the response object from the DisassociateFleet operation.

Class DomainJoinInfo

Contains the information needed to join a Microsoft Active Directory domain.

Class ExpireSessionRequest

Container for the parameters to the ExpireSession operation. Immediately stops the specified streaming session.

Class ExpireSessionResponse

This is the response object from the ExpireSession operation.

Class Fleet

Contains the parameters for a fleet.

Class FleetError

Describes a fleet error.

Class Image

Describes an image.

Class ImageBuilder

Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.

Class ImageBuilderStateChangeReason

Describes the reason why the last image builder state change occurred.

Class ImagePermissions

Describes the permissions for an image.

Class ImageStateChangeReason

Describes the reason why the last image state change occurred.

Class IncompatibleImageException

AppStream exception

Class InvalidAccountStatusException

AppStream exception

Class InvalidParameterCombinationException

AppStream exception

Class InvalidRoleException

AppStream exception

Class LimitExceededException

AppStream exception

Class ListAssociatedFleetsRequest

Container for the parameters to the ListAssociatedFleets operation. Retrieves the name of the fleet that is associated with the specified stack.

Class ListAssociatedFleetsResponse

This is the response object from the ListAssociatedFleets operation.

Class ListAssociatedStacksRequest

Container for the parameters to the ListAssociatedStacks operation. Retrieves the name of the stack with which the specified fleet is associated.

Class ListAssociatedStacksResponse

This is the response object from the ListAssociatedStacks operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. 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.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class NetworkAccessConfiguration

The network details of the fleet instance for the streaming session.

Class OperationNotPermittedException

AppStream exception

Class ResourceAlreadyExistsException

AppStream exception

Class ResourceError

Describes a resource error.

Class ResourceInUseException

AppStream exception

Class ResourceNotAvailableException

AppStream exception

Class ResourceNotFoundException

AppStream exception

Class ServiceAccountCredentials

Describes the credentials for the service account used by the streaming instance to connect to the directory.

Class Session

Describes a streaming session.

Class SharedImagePermissions

Describes the permissions that are available to the specified AWS account for a shared image.

Class Stack

Describes a stack.

Class StackError

Describes a stack error.

Class StartFleetRequest

Container for the parameters to the StartFleet operation. Starts the specified fleet.

Class StartFleetResponse

This is the response object from the StartFleet operation.

Class StartImageBuilderRequest

Container for the parameters to the StartImageBuilder operation. Starts the specified image builder.

Class StartImageBuilderResponse

This is the response object from the StartImageBuilder operation.

Class StopFleetRequest

Container for the parameters to the StopFleet operation. Stops the specified fleet.

Class StopFleetResponse

This is the response object from the StopFleet operation.

Class StopImageBuilderRequest

Container for the parameters to the StopImageBuilder operation. Stops the specified image builder.

Class StopImageBuilderResponse

This is the response object from the StopImageBuilder operation.

Class StorageConnector

Describes a connector to enable persistent storage for users.

Class TagResourceRequest

Container for the parameters to the TagResource operation. 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. 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.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateDirectoryConfigRequest

Container for the parameters to the UpdateDirectoryConfig operation. 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.

Class UpdateDirectoryConfigResponse

This is the response object from the UpdateDirectoryConfig operation.

Class UpdateFleetRequest

Container for the parameters to the UpdateFleet operation. 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.

Class UpdateFleetResponse

This is the response object from the UpdateFleet operation.

Class UpdateImagePermissionsRequest

Container for the parameters to the UpdateImagePermissions operation. Adds or updates permissions for the specified private image.

Class UpdateImagePermissionsResponse

This is the response object from the UpdateImagePermissions operation.

Class UpdateStackRequest

Container for the parameters to the UpdateStack operation. Updates the specified fields for the specified stack.

Class UpdateStackResponse

This is the response object from the UpdateStack operation.

Class UserSetting

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Class VpcConfig

Describes VPC configuration information.