AmazonAppStream (AWS SDK for Java

All Known Subinterfaces:

AmazonAppStreamAsync

All Known Implementing Classes:

AbstractAmazonAppStream, AbstractAmazonAppStreamAsync, AmazonAppStreamAsyncClient, AmazonAppStreamClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppStream
```
Interface for accessing Amazon AppStream.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAppStream instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AssociateFleetResult`	`associateFleet(AssociateFleetRequest associateFleetRequest)` Associates the specified fleet with the specified stack.
`BatchAssociateUserStackResult`	`batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest)` Associates the specified users with the specified stacks.
`BatchDisassociateUserStackResult`	`batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest)` Disassociates the specified users from the specified stacks.
`CopyImageResult`	`copyImage(CopyImageRequest copyImageRequest)` Copies the image within the same region or to a new region within the same AWS account.
`CreateDirectoryConfigResult`	`createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)` Creates a Directory Config object in AppStream 2.0.
`CreateFleetResult`	`createFleet(CreateFleetRequest createFleetRequest)` Creates a fleet.
`CreateImageBuilderResult`	`createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)` Creates an image builder.
`CreateImageBuilderStreamingURLResult`	`createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest createImageBuilderStreamingURLRequest)` Creates a URL to start an image builder streaming session.
`CreateStackResult`	`createStack(CreateStackRequest createStackRequest)` Creates a stack to start streaming applications to users.
`CreateStreamingURLResult`	`createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)` Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user.
`CreateUsageReportSubscriptionResult`	`createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest)` Creates a usage report subscription.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates a new user in the user pool.
`DeleteDirectoryConfigResult`	`deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)` Deletes the specified Directory Config object from AppStream 2.0.
`DeleteFleetResult`	`deleteFleet(DeleteFleetRequest deleteFleetRequest)` Deletes the specified fleet.
`DeleteImageResult`	`deleteImage(DeleteImageRequest deleteImageRequest)` Deletes the specified image.
`DeleteImageBuilderResult`	`deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)` Deletes the specified image builder and releases the capacity.
`DeleteImagePermissionsResult`	`deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest)` Deletes permissions for the specified private image.
`DeleteStackResult`	`deleteStack(DeleteStackRequest deleteStackRequest)` Deletes the specified stack.
`DeleteUsageReportSubscriptionResult`	`deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest)` Disables usage report generation.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Deletes a user from the user pool.
`DescribeDirectoryConfigsResult`	`describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)` Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided.
`DescribeFleetsResult`	`describeFleets(DescribeFleetsRequest describeFleetsRequest)` Retrieves a list that describes one or more specified fleets, if the fleet names are provided.
`DescribeImageBuildersResult`	`describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)` Retrieves a list that describes one or more specified image builders, if the image builder names are provided.
`DescribeImagePermissionsResult`	`describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest)` Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
`DescribeImagesResult`	`describeImages(DescribeImagesRequest describeImagesRequest)` Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided.
`DescribeSessionsResult`	`describeSessions(DescribeSessionsRequest describeSessionsRequest)` Retrieves a list that describes the streaming sessions for a specified stack and fleet.
`DescribeStacksResult`	`describeStacks(DescribeStacksRequest describeStacksRequest)` Retrieves a list that describes one or more specified stacks, if the stack names are provided.
`DescribeUsageReportSubscriptionsResult`	`describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest)` Retrieves a list that describes one or more usage report subscriptions.
`DescribeUsersResult`	`describeUsers(DescribeUsersRequest describeUsersRequest)` Retrieves a list that describes one or more specified users in the user pool.
`DescribeUserStackAssociationsResult`	`describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest)` Retrieves a list that describes the UserStackAssociation objects.
`DisableUserResult`	`disableUser(DisableUserRequest disableUserRequest)` Disables the specified user in the user pool.
`DisassociateFleetResult`	`disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)` Disassociates the specified fleet from the specified stack.
`EnableUserResult`	`enableUser(EnableUserRequest enableUserRequest)` Enables a user in the user pool.
`ExpireSessionResult`	`expireSession(ExpireSessionRequest expireSessionRequest)` Immediately stops the specified streaming session.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAssociatedFleetsResult`	`listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)` Retrieves the name of the fleet that is associated with the specified stack.
`ListAssociatedStacksResult`	`listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)` Retrieves the name of the stack with which the specified fleet is associated.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Retrieves a list of all tags for the specified AppStream 2.0 resource.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartFleetResult`	`startFleet(StartFleetRequest startFleetRequest)` Starts the specified fleet.
`StartImageBuilderResult`	`startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)` Starts the specified image builder.
`StopFleetResult`	`stopFleet(StopFleetRequest stopFleetRequest)` Stops the specified fleet.
`StopImageBuilderResult`	`stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)` Stops the specified image builder.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds or overwrites one or more tags for the specified AppStream 2.0 resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Disassociates one or more specified tags from the specified AppStream 2.0 resource.
`UpdateDirectoryConfigResult`	`updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)` Updates the specified Directory Config object in AppStream 2.0.
`UpdateFleetResult`	`updateFleet(UpdateFleetRequest updateFleetRequest)` Updates the specified fleet.
`UpdateImagePermissionsResult`	`updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest)` Adds or updates permissions for the specified private image.
`UpdateStackResult`	`updateStack(UpdateStackRequest updateStackRequest)` Updates the specified fields for the specified stack.
`AmazonAppStreamWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("appstream2.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "appstream2.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "appstream2.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "appstream2.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - associateFleet
```
AssociateFleetResult associateFleet(AssociateFleetRequest associateFleetRequest)
```
    Associates the specified fleet with the specified stack.
    
    Parameters:
    
    associateFleetRequest -
    
    Returns:
    
    Result of the AssociateFleet operation returned by the service.
    
    Throws:
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - batchAssociateUserStack
```
BatchAssociateUserStackResult batchAssociateUserStack(BatchAssociateUserStackRequest batchAssociateUserStackRequest)
```
    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.
    
    Parameters:
    
    batchAssociateUserStackRequest -
    
    Returns:
    
    Result of the BatchAssociateUserStack operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateUserStack
```
BatchDisassociateUserStackResult batchDisassociateUserStack(BatchDisassociateUserStackRequest batchDisassociateUserStackRequest)
```
    Disassociates the specified users from the specified stacks.
    
    Parameters:
    
    batchDisassociateUserStackRequest -
    
    Returns:
    
    Result of the BatchDisassociateUserStack operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copyImage
```
CopyImageResult copyImage(CopyImageRequest copyImageRequest)
```
    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.
    
    Parameters:
    
    copyImageRequest -
    
    Returns:
    
    Result of the CopyImage operation returned by the service.
    
    Throws:
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    See Also:
    
    AWS API Documentation
  - createDirectoryConfig
```
CreateDirectoryConfigResult createDirectoryConfig(CreateDirectoryConfigRequest createDirectoryConfigRequest)
```
    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.
    
    Parameters:
    
    createDirectoryConfigRequest -
    
    Returns:
    
    Result of the CreateDirectoryConfig operation returned by the service.
    
    Throws:
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    See Also:
    
    AWS API Documentation
  - createFleet
```
CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
```
    Creates a fleet. A fleet consists of streaming instances that run a specified image.
    
    Parameters:
    
    createFleetRequest -
    
    Returns:
    
    Result of the CreateFleet operation returned by the service.
    
    Throws:
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    ResourceNotFoundException - The specified resource was not found.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    InvalidRoleException - The specified role is invalid.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - createImageBuilder
```
CreateImageBuilderResult createImageBuilder(CreateImageBuilderRequest createImageBuilderRequest)
```
    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.
    
    Parameters:
    
    createImageBuilderRequest -
    
    Returns:
    
    Result of the CreateImageBuilder operation returned by the service.
    
    Throws:
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidRoleException - The specified role is invalid.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - createImageBuilderStreamingURL
```
CreateImageBuilderStreamingURLResult createImageBuilderStreamingURL(CreateImageBuilderStreamingURLRequest createImageBuilderStreamingURLRequest)
```
    Creates a URL to start an image builder streaming session.
    
    Parameters:
    
    createImageBuilderStreamingURLRequest -
    
    Returns:
    
    Result of the CreateImageBuilderStreamingURL operation returned by the service.
    
    Throws:
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - createStack
```
CreateStackResult createStack(CreateStackRequest createStackRequest)
```
    Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
    
    Parameters:
    
    createStackRequest -
    
    Returns:
    
    Result of the CreateStack operation returned by the service.
    
    Throws:
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    InvalidRoleException - The specified role is invalid.
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - createStreamingURL
```
CreateStreamingURLResult createStreamingURL(CreateStreamingURLRequest createStreamingURLRequest)
```
    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.
    
    Parameters:
    
    createStreamingURLRequest -
    
    Returns:
    
    Result of the CreateStreamingURL operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - createUsageReportSubscription
```
CreateUsageReportSubscriptionResult createUsageReportSubscription(CreateUsageReportSubscriptionRequest createUsageReportSubscriptionRequest)
```
    Creates a usage report subscription. Usage reports are generated daily.
    
    Parameters:
    
    createUsageReportSubscriptionRequest -
    
    Returns:
    
    Result of the CreateUsageReportSubscription operation returned by the service.
    
    Throws:
    
    InvalidRoleException - The specified role is invalid.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates a new user in the user pool.
    
    Parameters:
    
    createUserRequest -
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - deleteDirectoryConfig
```
DeleteDirectoryConfigResult deleteDirectoryConfig(DeleteDirectoryConfigRequest deleteDirectoryConfigRequest)
```
    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.
    
    Parameters:
    
    deleteDirectoryConfigRequest -
    
    Returns:
    
    Result of the DeleteDirectoryConfig operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteFleet
```
DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
```
    Deletes the specified fleet.
    
    Parameters:
    
    deleteFleetRequest -
    
    Returns:
    
    Result of the DeleteFleet operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteImage
```
DeleteImageResult deleteImage(DeleteImageRequest deleteImageRequest)
```
    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.
    
    Parameters:
    
    deleteImageRequest -
    
    Returns:
    
    Result of the DeleteImage operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteImageBuilder
```
DeleteImageBuilderResult deleteImageBuilder(DeleteImageBuilderRequest deleteImageBuilderRequest)
```
    Deletes the specified image builder and releases the capacity.
    
    Parameters:
    
    deleteImageBuilderRequest -
    
    Returns:
    
    Result of the DeleteImageBuilder operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteImagePermissions
```
DeleteImagePermissionsResult deleteImagePermissions(DeleteImagePermissionsRequest deleteImagePermissionsRequest)
```
    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.
    
    Parameters:
    
    deleteImagePermissionsRequest -
    
    Returns:
    
    Result of the DeleteImagePermissions operation returned by the service.
    
    Throws:
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteStack
```
DeleteStackResult deleteStack(DeleteStackRequest deleteStackRequest)
```
    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.
    
    Parameters:
    
    deleteStackRequest -
    
    Returns:
    
    Result of the DeleteStack operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteUsageReportSubscription
```
DeleteUsageReportSubscriptionResult deleteUsageReportSubscription(DeleteUsageReportSubscriptionRequest deleteUsageReportSubscriptionRequest)
```
    Disables usage report generation.
    
    Parameters:
    
    deleteUsageReportSubscriptionRequest -
    
    Returns:
    
    Result of the DeleteUsageReportSubscription operation returned by the service.
    
    Throws:
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes a user from the user pool.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeDirectoryConfigs
```
DescribeDirectoryConfigsResult describeDirectoryConfigs(DescribeDirectoryConfigsRequest describeDirectoryConfigsRequest)
```
    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.
    
    Parameters:
    
    describeDirectoryConfigsRequest -
    
    Returns:
    
    Result of the DescribeDirectoryConfigs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeFleets
```
DescribeFleetsResult describeFleets(DescribeFleetsRequest describeFleetsRequest)
```
    Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
    
    Parameters:
    
    describeFleetsRequest -
    
    Returns:
    
    Result of the DescribeFleets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeImageBuilders
```
DescribeImageBuildersResult describeImageBuilders(DescribeImageBuildersRequest describeImageBuildersRequest)
```
    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.
    
    Parameters:
    
    describeImageBuildersRequest -
    
    Returns:
    
    Result of the DescribeImageBuilders operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeImagePermissions
```
DescribeImagePermissionsResult describeImagePermissions(DescribeImagePermissionsRequest describeImagePermissionsRequest)
```
    Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
    
    Parameters:
    
    describeImagePermissionsRequest -
    
    Returns:
    
    Result of the DescribeImagePermissions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeImages
```
DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)
```
    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.
    
    Parameters:
    
    describeImagesRequest -
    
    Returns:
    
    Result of the DescribeImages operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeSessions
```
DescribeSessionsResult describeSessions(DescribeSessionsRequest describeSessionsRequest)
```
    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.
    
    Parameters:
    
    describeSessionsRequest -
    
    Returns:
    
    Result of the DescribeSessions operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - describeStacks
```
DescribeStacksResult describeStacks(DescribeStacksRequest describeStacksRequest)
```
    Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
    
    Parameters:
    
    describeStacksRequest -
    
    Returns:
    
    Result of the DescribeStacks operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - describeUsageReportSubscriptions
```
DescribeUsageReportSubscriptionsResult describeUsageReportSubscriptions(DescribeUsageReportSubscriptionsRequest describeUsageReportSubscriptionsRequest)
```
    Retrieves a list that describes one or more usage report subscriptions.
    
    Parameters:
    
    describeUsageReportSubscriptionsRequest -
    
    Returns:
    
    Result of the DescribeUsageReportSubscriptions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    See Also:
    
    AWS API Documentation
  - describeUserStackAssociations
```
DescribeUserStackAssociationsResult describeUserStackAssociations(DescribeUserStackAssociationsRequest describeUserStackAssociationsRequest)
```
    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
    Parameters:
    
    describeUserStackAssociationsRequest -
    
    Returns:
    
    Result of the DescribeUserStackAssociations operation returned by the service.
    
    Throws:
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - describeUsers
```
DescribeUsersResult describeUsers(DescribeUsersRequest describeUsersRequest)
```
    Retrieves a list that describes one or more specified users in the user pool.
    
    Parameters:
    
    describeUsersRequest -
    
    Returns:
    
    Result of the DescribeUsers operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    See Also:
    
    AWS API Documentation
  - disableUser
```
DisableUserResult disableUser(DisableUserRequest disableUserRequest)
```
    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.
    
    Parameters:
    
    disableUserRequest -
    
    Returns:
    
    Result of the DisableUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - disassociateFleet
```
DisassociateFleetResult disassociateFleet(DisassociateFleetRequest disassociateFleetRequest)
```
    Disassociates the specified fleet from the specified stack.
    
    Parameters:
    
    disassociateFleetRequest -
    
    Returns:
    
    Result of the DisassociateFleet operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - enableUser
```
EnableUserResult enableUser(EnableUserRequest enableUserRequest)
```
    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.
    
    Parameters:
    
    enableUserRequest -
    
    Returns:
    
    Result of the EnableUser operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    See Also:
    
    AWS API Documentation
  - expireSession
```
ExpireSessionResult expireSession(ExpireSessionRequest expireSessionRequest)
```
    Immediately stops the specified streaming session.
    
    Parameters:
    
    expireSessionRequest -
    
    Returns:
    
    Result of the ExpireSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedFleets
```
ListAssociatedFleetsResult listAssociatedFleets(ListAssociatedFleetsRequest listAssociatedFleetsRequest)
```
    Retrieves the name of the fleet that is associated with the specified stack.
    
    Parameters:
    
    listAssociatedFleetsRequest -
    
    Returns:
    
    Result of the ListAssociatedFleets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedStacks
```
ListAssociatedStacksResult listAssociatedStacks(ListAssociatedStacksRequest listAssociatedStacksRequest)
```
    Retrieves the name of the stack with which the specified fleet is associated.
    
    Parameters:
    
    listAssociatedStacksRequest -
    
    Returns:
    
    Result of the ListAssociatedStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    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.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - startFleet
```
StartFleetResult startFleet(StartFleetRequest startFleetRequest)
```
    Starts the specified fleet.
    
    Parameters:
    
    startFleetRequest -
    
    Returns:
    
    Result of the StartFleet operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    InvalidRoleException - The specified role is invalid.
    
    See Also:
    
    AWS API Documentation
  - startImageBuilder
```
StartImageBuilderResult startImageBuilder(StartImageBuilderRequest startImageBuilderRequest)
```
    Starts the specified image builder.
    
    Parameters:
    
    startImageBuilderRequest -
    
    Returns:
    
    Result of the StartImageBuilder operation returned by the service.
    
    Throws:
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    See Also:
    
    AWS API Documentation
  - stopFleet
```
StopFleetResult stopFleet(StopFleetRequest stopFleetRequest)
```
    Stops the specified fleet.
    
    Parameters:
    
    stopFleetRequest -
    
    Returns:
    
    Result of the StopFleet operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - stopImageBuilder
```
StopImageBuilderResult stopImageBuilder(StopImageBuilderRequest stopImageBuilderRequest)
```
    Stops the specified image builder.
    
    Parameters:
    
    stopImageBuilderRequest -
    
    Returns:
    
    Result of the StopImageBuilder operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    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.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    See Also:
    
    AWS API Documentation
  - updateDirectoryConfig
```
UpdateDirectoryConfigResult updateDirectoryConfig(UpdateDirectoryConfigRequest updateDirectoryConfigRequest)
```
    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.
    
    Parameters:
    
    updateDirectoryConfigRequest -
    
    Returns:
    
    Result of the UpdateDirectoryConfig operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - updateFleet
```
UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)
```
    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.
    
    Parameters:
    
    updateFleetRequest -
    
    Returns:
    
    Result of the UpdateFleet operation returned by the service.
    
    Throws:
    
    ResourceInUseException - The specified resource is in use.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    InvalidRoleException - The specified role is invalid.
    
    ResourceNotFoundException - The specified resource was not found.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    See Also:
    
    AWS API Documentation
  - updateImagePermissions
```
UpdateImagePermissionsResult updateImagePermissions(UpdateImagePermissionsRequest updateImagePermissionsRequest)
```
    Adds or updates permissions for the specified private image.
    
    Parameters:
    
    updateImagePermissionsRequest -
    
    Returns:
    
    Result of the UpdateImagePermissions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    ResourceNotAvailableException - The specified resource exists and is not in use, but isn't available.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    See Also:
    
    AWS API Documentation
  - updateStack
```
UpdateStackResult updateStack(UpdateStackRequest updateStackRequest)
```
    Updates the specified fields for the specified stack.
    
    Parameters:
    
    updateStackRequest -
    
    Returns:
    
    Result of the UpdateStack operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource was not found.
    
    ResourceInUseException - The specified resource is in use.
    
    InvalidRoleException - The specified role is invalid.
    
    InvalidParameterCombinationException - Indicates an incorrect combination of parameters, or a missing parameter.
    
    LimitExceededException - The requested limit exceeds the permitted limit for an account.
    
    InvalidAccountStatusException - The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
    
    IncompatibleImageException - The image does not support storage connectors.
    
    OperationNotPermittedException - The attempted operation is not permitted.
    
    ConcurrentModificationException - An API error occurred. Wait a few minutes and try again.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AmazonAppStreamWaiters waiters()
```

Did this page help you?

Interface AmazonAppStream

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

associateFleet

batchAssociateUserStack

batchDisassociateUserStack

copyImage

createDirectoryConfig

createFleet

createImageBuilder

createImageBuilderStreamingURL

createStack

createStreamingURL

createUsageReportSubscription

createUser

deleteDirectoryConfig

deleteFleet

deleteImage

deleteImageBuilder

deleteImagePermissions

deleteStack

deleteUsageReportSubscription

deleteUser

describeDirectoryConfigs

describeFleets

describeImageBuilders

describeImagePermissions

describeImages

describeSessions

describeStacks

describeUsageReportSubscriptions

describeUserStackAssociations

describeUsers

disableUser

disassociateFleet

enableUser

expireSession

listAssociatedFleets

listAssociatedStacks

listTagsForResource

startFleet

startImageBuilder

stopFleet

stopImageBuilder

tagResource

untagResource

updateDirectoryConfig

updateFleet

updateImagePermissions

updateStack

shutdown

getCachedResponseMetadata

waiters