AWS.AppStream (aws-elixir v0.8.0) View Source

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:

Link to this section Summary

Functions

Associates the specified fleet with the specified stack.

Associates the specified users with the specified stacks.

Disassociates the specified users from the specified stacks.

Copies the image within the same region or to a new region within the same AWS account.

Creates a Directory Config object in AppStream 2.0.

Creates a URL to start an image builder streaming session.

Creates a stack to start streaming applications to users.

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.

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

Creates a new user in the user pool.

Deletes the specified Directory Config object from AppStream 2.0.

Deletes the specified fleet.

Deletes the specified image.

Deletes the specified image builder and releases the capacity.

Deletes permissions for the specified private image.

Deletes the specified stack.

Deletes a user from the user pool.

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.

Retrieves a list that describes one or more specified fleets, if the fleet names are provided.

Retrieves a list that describes one or more specified image builders, if the image builder names are provided.

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

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.

Retrieves a list that describes the streaming sessions for a specified stack and fleet.

Retrieves a list that describes one or more specified stacks, if the stack names are provided.

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

Retrieves a list that describes the UserStackAssociation objects.

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

Disables the specified user in the user pool.

Disassociates the specified fleet from the specified stack.

Enables a user in the user pool.

Immediately stops the specified streaming session.

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

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

Retrieves a list of all tags for the specified AppStream 2.0 resource.

Starts the specified fleet.

Starts the specified image builder.

Stops the specified fleet.

Stops the specified image builder.

Adds or overwrites one or more tags for the specified AppStream 2.0 resource.

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

Updates the specified Directory Config object in AppStream 2.0.

Updates the specified fleet.

Adds or updates permissions for the specified private image.

Updates the specified fields for the specified stack.

Link to this section Functions

Link to this function

associate_fleet(client, input, options \\ [])

View Source

Associates the specified fleet with the specified stack.

Link to this function

batch_associate_user_stack(client, input, options \\ [])

View Source

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.

Link to this function

batch_disassociate_user_stack(client, input, options \\ [])

View Source

Disassociates the specified users from the specified stacks.

Link to this function

copy_image(client, input, options \\ [])

View Source

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.

Link to this function

create_directory_config(client, input, options \\ [])

View Source

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.

Link to this function

create_fleet(client, input, options \\ [])

View Source

Creates a fleet.

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

Link to this function

create_image_builder(client, input, options \\ [])

View Source

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.

Link to this function

create_image_builder_streaming_url(client, input, options \\ [])

View Source

Creates a URL to start an image builder streaming session.

Link to this function

create_stack(client, input, options \\ [])

View Source

Creates a stack to start streaming applications to users.

A stack consists of an associated fleet, user access policies, and storage configurations.

Link to this function

create_streaming_url(client, input, options \\ [])

View Source

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.

Link to this function

create_updated_image(client, input, options \\ [])

View Source

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.

Link to this function

create_usage_report_subscription(client, input, options \\ [])

View Source

Creates a usage report subscription.

Usage reports are generated daily.

Link to this function

create_user(client, input, options \\ [])

View Source

Creates a new user in the user pool.

Link to this function

delete_directory_config(client, input, options \\ [])

View Source

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.

Link to this function

delete_fleet(client, input, options \\ [])

View Source

Deletes the specified fleet.

Link to this function

delete_image(client, input, options \\ [])

View Source

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.

Link to this function

delete_image_builder(client, input, options \\ [])

View Source

Deletes the specified image builder and releases the capacity.

Link to this function

delete_image_permissions(client, input, options \\ [])

View Source

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.

Link to this function

delete_stack(client, input, options \\ [])

View Source

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.

Link to this function

delete_usage_report_subscription(client, input, options \\ [])

View Source

Disables usage report generation.

Link to this function

delete_user(client, input, options \\ [])

View Source

Deletes a user from the user pool.

Link to this function

describe_directory_configs(client, input, options \\ [])

View Source

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.

Link to this function

describe_fleets(client, input, options \\ [])

View Source

Retrieves a list that describes one or more specified fleets, if the fleet names are provided.

Otherwise, all fleets in the account are described.

Link to this function

describe_image_builders(client, input, options \\ [])

View Source

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.

Link to this function

describe_image_permissions(client, input, options \\ [])

View Source

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

Link to this function

describe_images(client, input, options \\ [])

View Source

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.

Link to this function

describe_sessions(client, input, options \\ [])

View Source

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.

Link to this function

describe_stacks(client, input, options \\ [])

View Source

Retrieves a list that describes one or more specified stacks, if the stack names are provided.

Otherwise, all stacks in the account are described.

Link to this function

describe_usage_report_subscriptions(client, input, options \\ [])

View Source

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

Link to this function

describe_user_stack_associations(client, input, options \\ [])

View Source

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

Link to this function

describe_users(client, input, options \\ [])

View Source

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

Link to this function

disable_user(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_fleet(client, input, options \\ [])

View Source

Disassociates the specified fleet from the specified stack.

Link to this function

enable_user(client, input, options \\ [])

View Source

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.

Link to this function

expire_session(client, input, options \\ [])

View Source

Immediately stops the specified streaming session.

Link to this function

list_associated_fleets(client, input, options \\ [])

View Source

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

Link to this function

list_associated_stacks(client, input, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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.

Link to this function

start_fleet(client, input, options \\ [])

View Source

Starts the specified fleet.

Link to this function

start_image_builder(client, input, options \\ [])

View Source

Starts the specified image builder.

Link to this function

stop_fleet(client, input, options \\ [])

View Source

Stops the specified fleet.

Link to this function

stop_image_builder(client, input, options \\ [])

View Source

Stops the specified image builder.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

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.

Link to this function

update_directory_config(client, input, options \\ [])

View Source

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.

Link to this function

update_fleet(client, input, options \\ [])

View Source

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.

Link to this function

update_image_permissions(client, input, options \\ [])

View Source

Adds or updates permissions for the specified private image.

Link to this function

update_stack(client, input, options \\ [])

View Source

Updates the specified fields for the specified stack.