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 AccessEndpoint

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

Class Application

Describes an application in the application catalog.

Class ApplicationSettings

The persistent application settings for users of a stack.

Class ApplicationSettingsResponse

Describes the persistent application settings for users of a stack.

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 BatchAssociateUserStackRequest

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

Class BatchAssociateUserStackResponse

This is the response object from the BatchAssociateUserStack operation.

Class BatchDisassociateUserStackRequest

Container for the parameters to the BatchDisassociateUserStack operation. Disassociates the specified users from the specified stacks.

Class BatchDisassociateUserStackResponse

This is the response object from the BatchDisassociateUserStack operation.

Class ComputeCapacity

Describes the capacity for a fleet.

Class ComputeCapacityStatus

Describes the capacity status for a fleet.

Class ConcurrentModificationException

An API error occurred. Wait a few minutes and try again.

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 configuration information required to join fleets and image builders to Microsoft Active Directory domains.

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 CreateUsageReportSubscriptionRequest

Container for the parameters to the CreateUsageReportSubscription operation. Creates a usage report subscription. Usage reports are generated daily.

Class CreateUsageReportSubscriptionResponse

This is the response object from the CreateUsageReportSubscription operation.

Class CreateUserRequest

Container for the parameters to the CreateUser operation. Creates a new user in the user pool.

Class CreateUserResponse

This is the response object from the CreateUser 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 DeleteUsageReportSubscriptionRequest

Container for the parameters to the DeleteUsageReportSubscription operation. Disables usage report generation.

Class DeleteUsageReportSubscriptionResponse

This is the response object from the DeleteUsageReportSubscription operation.

Class DeleteUserRequest

Container for the parameters to the DeleteUser operation. Deletes a user from the user pool.

Class DeleteUserResponse

This is the response object from the DeleteUser 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 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.

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 shared AWS account IDs on 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 or image ARNs 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 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.

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 DescribeUsageReportSubscriptionsRequest

Container for the parameters to the DescribeUsageReportSubscriptions operation. Retrieves a list that describes one or more usage report subscriptions.

Class DescribeUsageReportSubscriptionsResponse

This is the response object from the DescribeUsageReportSubscriptions operation.

Class DescribeUsersRequest

Container for the parameters to the DescribeUsers operation. Retrieves a list that describes one or more specified users in the user pool.

Class DescribeUsersResponse

This is the response object from the DescribeUsers operation.

Class DescribeUserStackAssociationsRequest

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

Class DescribeUserStackAssociationsResponse

This is the response object from the DescribeUserStackAssociations operation.

Class DirectoryConfig

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Class DisableUserRequest

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

Class DisableUserResponse

This is the response object from the DisableUser operation.

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

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Class EnableUserRequest

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

Class EnableUserResponse

This is the response object from the EnableUser operation.

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

Describes a fleet.

Class FleetError

Describes a fleet error.

Class Image

Describes an image.

Class ImageBuilder

Describes a virtual machine that is used to create an image.

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

The image does not support storage connectors.

Class InvalidAccountStatusException

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

Class InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

Class InvalidRoleException

The specified role is invalid.

Class LastReportGenerationExecutionError

Describes the error that is returned when a usage report can't be generated.

Class LimitExceededException

The requested limit exceeds the permitted limit for an account.

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

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class NetworkAccessConfiguration

Describes the network details of the fleet or image builder instance.

Class OperationNotPermittedException

The attempted operation is not permitted.

Class ResourceAlreadyExistsException

The specified resource already exists.

Class ResourceError

Describes a resource error.

Class ResourceInUseException

The specified resource is in use.

Class ResourceNotAvailableException

The specified resource exists and is not in use, but isn't available.

Class ResourceNotFoundException

The specified resource was not found.

Class ServiceAccountCredentials

Describes the credentials for the service account used by the fleet or image builder 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 that enables 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 Administration 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 Administration 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 configuration information required to join fleets and image builders to Microsoft Active Directory domains.

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, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds 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 UsageReportSubscription

Describes information about the usage report subscription.

Class User

Describes a user in the user pool.

Class UserSetting

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

Class UserStackAssociation

Describes a user in the user pool and the associated stack.

Class UserStackAssociationError

Describes the error that is returned when a user can’t be associated with or disassociated from a stack.

Class VpcConfig

Describes VPC configuration information for fleets and image builders.