aws_appstream

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:

• Amazon AppStream 2.0 product page

• Amazon AppStream 2.0 documentation

Summary

Functions

• associate_fleet(Client, Input)
  Associates the specified fleet with the specified stack.
• associate_fleet(Client, Input, Options)
• batch_associate_user_stack(Client, Input)
  Associates the specified users with the specified stacks.
• batch_associate_user_stack(Client, Input, Options)
• batch_disassociate_user_stack(Client, Input)
  Disassociates the specified users from the specified stacks.
• batch_disassociate_user_stack(Client, Input, Options)
• copy_image(Client, Input)
  Copies the image within the same region or to a new region within the same AWS account.
• copy_image(Client, Input, Options)
• create_directory_config(Client, Input)
  Creates a Directory Config object in AppStream 2.0.
• create_directory_config(Client, Input, Options)
• create_fleet(Client, Input)
  Creates a fleet.
• create_fleet(Client, Input, Options)
• create_image_builder(Client, Input)
  Creates an image builder.
• create_image_builder(Client, Input, Options)
• create_image_builder_streaming_u_r_l(Client, Input)
  Creates a URL to start an image builder streaming session.
• create_image_builder_streaming_u_r_l(Client, Input, Options)
• create_stack(Client, Input)
  Creates a stack to start streaming applications to users.
• create_stack(Client, Input, Options)
• create_streaming_u_r_l(Client, Input)
  Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
• create_streaming_u_r_l(Client, Input, Options)
• create_usage_report_subscription(Client, Input)
  Creates a usage report subscription.
• create_usage_report_subscription(Client, Input, Options)
• create_user(Client, Input)
  Creates a new user in the user pool.
• create_user(Client, Input, Options)
• delete_directory_config(Client, Input)
  Deletes the specified Directory Config object from AppStream 2.0.
• delete_directory_config(Client, Input, Options)
• delete_fleet(Client, Input)
  Deletes the specified fleet.
• delete_fleet(Client, Input, Options)
• delete_image(Client, Input)
  Deletes the specified image.
• delete_image(Client, Input, Options)
• delete_image_builder(Client, Input)
  Deletes the specified image builder and releases the capacity.
• delete_image_builder(Client, Input, Options)
• delete_image_permissions(Client, Input)
  Deletes permissions for the specified private image.
• delete_image_permissions(Client, Input, Options)
• delete_stack(Client, Input)
  Deletes the specified stack.
• delete_stack(Client, Input, Options)
• delete_usage_report_subscription(Client, Input)
  Disables usage report generation.
• delete_usage_report_subscription(Client, Input, Options)
• delete_user(Client, Input)
  Deletes a user from the user pool.
• delete_user(Client, Input, Options)
• describe_directory_configs(Client, Input)
  Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.
• describe_directory_configs(Client, Input, Options)
• describe_fleets(Client, Input)
  Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
• describe_fleets(Client, Input, Options)
• describe_image_builders(Client, Input)
  Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
• describe_image_builders(Client, Input, Options)
• describe_image_permissions(Client, Input)
  Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
• describe_image_permissions(Client, Input, Options)
• describe_images(Client, Input)
  Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
• describe_images(Client, Input, Options)
• describe_sessions(Client, Input)
  Retrieves a list that describes the streaming sessions for a specified stack and fleet.
• describe_sessions(Client, Input, Options)
• describe_stacks(Client, Input)
  Retrieves a list that describes one or more specified stacks, if the stack names are provided.
• describe_stacks(Client, Input, Options)
• describe_usage_report_subscriptions(Client, Input)
  Retrieves a list that describes one or more usage report subscriptions.
• describe_usage_report_subscriptions(Client, Input, Options)
• describe_user_stack_associations(Client, Input)
  Retrieves a list that describes the UserStackAssociation objects.
• describe_user_stack_associations(Client, Input, Options)
• describe_users(Client, Input)
  Retrieves a list that describes one or more specified users in the user pool.
• describe_users(Client, Input, Options)
• disable_user(Client, Input)
  Disables the specified user in the user pool.
• disable_user(Client, Input, Options)
• disassociate_fleet(Client, Input)
  Disassociates the specified fleet from the specified stack.
• disassociate_fleet(Client, Input, Options)
• enable_user(Client, Input)
  Enables a user in the user pool.
• enable_user(Client, Input, Options)
• expire_session(Client, Input)
  Immediately stops the specified streaming session.
• expire_session(Client, Input, Options)
• list_associated_fleets(Client, Input)
  Retrieves the name of the fleet that is associated with the specified stack.
• list_associated_fleets(Client, Input, Options)
• list_associated_stacks(Client, Input)
  Retrieves the name of the stack with which the specified fleet is associated.
• list_associated_stacks(Client, Input, Options)
• list_tags_for_resource(Client, Input)
  Retrieves a list of all tags for the specified AppStream 2.0 resource.
• list_tags_for_resource(Client, Input, Options)
• start_fleet(Client, Input)
  Starts the specified fleet.
• start_fleet(Client, Input, Options)
• start_image_builder(Client, Input)
  Starts the specified image builder.
• start_image_builder(Client, Input, Options)
• stop_fleet(Client, Input)
  Stops the specified fleet.
• stop_fleet(Client, Input, Options)
• stop_image_builder(Client, Input)
  Stops the specified image builder.
• stop_image_builder(Client, Input, Options)
• tag_resource(Client, Input)
  Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
• tag_resource(Client, Input, Options)
• untag_resource(Client, Input)
  Disassociates one or more specified tags from the specified AppStream 2.0 resource.
• untag_resource(Client, Input, Options)
• update_directory_config(Client, Input)
  Updates the specified Directory Config object in AppStream 2.0.
• update_directory_config(Client, Input, Options)
• update_fleet(Client, Input)
  Updates the specified fleet.
• update_fleet(Client, Input, Options)
• update_image_permissions(Client, Input)
  Adds or updates permissions for the specified private image.
• update_image_permissions(Client, Input, Options)
• update_stack(Client, Input)
  Updates the specified fields for the specified stack.
• update_stack(Client, Input, Options)

Functions

Associates the specified fleet with the specified stack.

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.

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. Note that any tags you added to the image will not be copied.

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.

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

Creates an image builder. An image builder is a virtual machine that is used to create an image.

Creates a URL to start an image builder streaming session.

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

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.

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

Creates a new user in the user pool.

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.

Deletes the specified fleet.

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.

Deletes the specified image builder and releases the capacity.

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.

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.

Disables usage report generation.

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

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

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.

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. Otherwise, all images in the account are described.

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.

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

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

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

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

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.

Disassociates the specified fleet from the specified stack.

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.

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. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

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

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

To list the current tags for your resources, use ListTagsForResource.

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.

Updates the specified fleet.

Adds or updates permissions for the specified private image.

Updates the specified fields for the specified stack.