AppStreamClient

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:

Installation

NPM
npm install @aws-sdk/client-appstream
Yarn
yarn add @aws-sdk/client-appstream
pnpm
pnpm add @aws-sdk/client-appstream

AppStreamClient Operations

Command
Summary
AssociateAppBlockBuilderAppBlockCommand

Associates the specified app block builder with the specified app block.

AssociateApplicationFleetCommand

Associates the specified application with the specified fleet. This is only supported for Elastic fleets.

AssociateApplicationToEntitlementCommand

Associates an application to entitle.

AssociateFleetCommand

Associates the specified fleet with the specified stack.

BatchAssociateUserStackCommand

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.

BatchDisassociateUserStackCommand

Disassociates the specified users from the specified stacks.

CopyImageCommand

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.

CreateAppBlockBuilderCommand

Creates an app block builder.

CreateAppBlockBuilderStreamingURLCommand

Creates a URL to start a create app block builder streaming session.

CreateAppBlockCommand

Creates an app block.

App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block.

This is only supported for Elastic fleets.

CreateApplicationCommand

Creates an application.

Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch.

This is only supported for Elastic fleets.

CreateDirectoryConfigCommand

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.

CreateEntitlementCommand

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

CreateFleetCommand

Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.

CreateImageBuilderCommand

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.

CreateImageBuilderStreamingURLCommand

Creates a URL to start an image builder streaming session.

CreateStackCommand

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

CreateStreamingURLCommand

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.

CreateThemeForStackCommand

Creates custom branding that customizes the appearance of the streaming application catalog page.

CreateUpdatedImageCommand

Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.

For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images , in the Amazon AppStream 2.0 Administration Guide.

CreateUsageReportSubscriptionCommand

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

CreateUserCommand

Creates a new user in the user pool.

DeleteAppBlockBuilderCommand

Deletes an app block builder.

An app block builder can only be deleted when it has no association with an app block.

DeleteAppBlockCommand

Deletes an app block.

DeleteApplicationCommand

Deletes an application.

DeleteDirectoryConfigCommand

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.

DeleteEntitlementCommand

Deletes the specified entitlement.

DeleteFleetCommand

Deletes the specified fleet.

DeleteImageBuilderCommand

Deletes the specified image builder and releases the capacity.

DeleteImageCommand

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.

DeleteImagePermissionsCommand

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.

DeleteStackCommand

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.

DeleteThemeForStackCommand

Deletes custom branding that customizes the appearance of the streaming application catalog page.

DeleteUsageReportSubscriptionCommand

Disables usage report generation.

DeleteUserCommand

Deletes a user from the user pool.

DescribeAppBlockBuilderAppBlockAssociationsCommand

Retrieves a list that describes one or more app block builder associations.

DescribeAppBlockBuildersCommand

Retrieves a list that describes one or more app block builders.

DescribeAppBlocksCommand

Retrieves a list that describes one or more app blocks.

DescribeApplicationFleetAssociationsCommand

Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.

DescribeApplicationsCommand

Retrieves a list that describes one or more applications.

DescribeDirectoryConfigsCommand

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.

DescribeEntitlementsCommand

Retrieves a list that describes one of more entitlements.

DescribeFleetsCommand

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

DescribeImageBuildersCommand

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.

DescribeImagePermissionsCommand

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

DescribeImagesCommand

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.

DescribeSessionsCommand

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.

DescribeStacksCommand

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

DescribeThemeForStackCommand

Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.

DescribeUsageReportSubscriptionsCommand

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

DescribeUserStackAssociationsCommand

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

DescribeUsersCommand

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

DisableUserCommand

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.

DisassociateAppBlockBuilderAppBlockCommand

Disassociates a specified app block builder from a specified app block.

DisassociateApplicationFleetCommand

Disassociates the specified application from the fleet.

DisassociateApplicationFromEntitlementCommand

Deletes the specified application from the specified entitlement.

DisassociateFleetCommand

Disassociates the specified fleet from the specified stack.

EnableUserCommand

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.

ExpireSessionCommand

Immediately stops the specified streaming session.

ListAssociatedFleetsCommand

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

ListAssociatedStacksCommand

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

ListEntitledApplicationsCommand

Retrieves a list of entitled applications.

ListTagsForResourceCommand

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.

StartAppBlockBuilderCommand

Starts an app block builder.

An app block builder can only be started when it's associated with an app block.

Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.

StartFleetCommand

Starts the specified fleet.

StartImageBuilderCommand

Starts the specified image builder.

StopAppBlockBuilderCommand

Stops an app block builder.

Stopping an app block builder terminates the instance, and the instance state is not persisted.

StopFleetCommand

Stops the specified fleet.

StopImageBuilderCommand

Stops the specified image builder.

TagResourceCommand

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.

UntagResourceCommand

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.

UpdateAppBlockBuilderCommand

Updates an app block builder.

If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.

UpdateApplicationCommand

Updates the specified application.

UpdateDirectoryConfigCommand

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.

UpdateEntitlementCommand

Updates the specified entitlement.

UpdateFleetCommand

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 following based on the fleet type:

  • Always-On and On-Demand fleet types

    You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes.

  • Elastic fleet type

    You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes.

If the fleet is in the STARTING or STOPPED state, you can't update it.

UpdateImagePermissionsCommand

Adds or updates permissions for the specified private image.

UpdateStackCommand

Updates the specified fields for the specified stack.

UpdateThemeForStackCommand

Updates custom branding that customizes the appearance of the streaming application catalog page.

AppStreamClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: AppStreamClientConfig